From 35f4be43879ab5336f4d03ec5fdaba8a475f268d Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?David=20S=C3=A1nchez?= Date: Thu, 6 May 2021 18:13:55 +0200 Subject: [PATCH 01/20] [Security Solution][Endpoint] User can edit existing event filters from the list (#98898) * Makes width 100% to allow multilang * Removes state/index types and move those types into the parent types file * Allows fill form from existing exception by id. Adds unit tests. Fixes wrong comments display when there is more than one comment. * Allows user update an existing event filter. Adds unit tests. Fixes some wrong behaviours when opening the flyout after create/update action * Fixes typo * Fixes wrong entry type * Uses selectors when it's possible instead of accessing directly to state object * Fixes typechecks * Allows edit from the card edit button. Removes unused imports and fixes some types * Reverts type name * Changes reducer to don't add entry to the list manually after creation, list will be reloaded with api call. Also check always if data exists to display the add new entry button at the first time --- x-pack/plugins/lists/public/shared_exports.ts | 2 +- .../public/management/common/routing.ts | 7 +- .../pages/event_filters/service/index.ts | 22 +- .../pages/event_filters/state/index.ts | 25 +-- .../pages/event_filters/store/action.ts | 30 ++- .../pages/event_filters/store/builders.ts | 1 + .../event_filters/store/middleware.test.ts | 128 ++++++++++-- .../pages/event_filters/store/middleware.ts | 139 ++++++++++++- .../pages/event_filters/store/reducer.test.ts | 36 ++-- .../pages/event_filters/store/reducer.ts | 22 +- .../pages/event_filters/store/selector.ts | 47 ++++- .../event_filters/store/selectors.test.ts | 49 ++++- .../pages/event_filters/test_utils/index.ts | 2 +- .../management/pages/event_filters/types.ts | 23 ++- .../view/components/empty/index.tsx | 4 +- .../view/components/flyout/index.test.tsx | 65 ++++-- .../view/components/flyout/index.tsx | 189 ++++++++++-------- .../view/components/form/index.test.tsx | 4 +- .../view/components/form/index.tsx | 25 ++- .../view/event_filters_list_page.tsx | 66 +++++- .../pages/event_filters/view/hooks.ts | 37 +++- .../pages/event_filters/view/translations.ts | 34 +++- .../use_event_filters_notification.test.tsx | 108 +++++++++- .../public/shared_imports.ts | 1 + 24 files changed, 842 insertions(+), 224 deletions(-) diff --git a/x-pack/plugins/lists/public/shared_exports.ts b/x-pack/plugins/lists/public/shared_exports.ts index 0aecf8a8f6c85..2032a44a8fd33 100644 --- a/x-pack/plugins/lists/public/shared_exports.ts +++ b/x-pack/plugins/lists/public/shared_exports.ts @@ -39,4 +39,4 @@ export { UseExceptionListsSuccess, } from './exceptions/types'; export * as ExceptionBuilder from './exceptions/components/builder/index'; -export { transformNewItemOutput } from './exceptions/transforms'; +export { transformNewItemOutput, transformOutput } from './exceptions/transforms'; diff --git a/x-pack/plugins/security_solution/public/management/common/routing.ts b/x-pack/plugins/security_solution/public/management/common/routing.ts index c97f3e8bf8d42..32079d97d24e1 100644 --- a/x-pack/plugins/security_solution/public/management/common/routing.ts +++ b/x-pack/plugins/security_solution/public/management/common/routing.ts @@ -24,8 +24,7 @@ import { AdministrationSubTab } from '../types'; import { appendSearch } from '../../common/components/link_to/helpers'; import { EndpointIndexUIQueryParams } from '../pages/endpoint_hosts/types'; import { TrustedAppsListPageLocation } from '../pages/trusted_apps/state'; -import { EventFiltersPageLocation } from '../pages/event_filters/state'; -import { EventFiltersListPageUrlSearchParams } from '../pages/event_filters/types'; +import { EventFiltersPageLocation } from '../pages/event_filters/types'; // Taken from: https://github.com/microsoft/TypeScript/issues/12936#issuecomment-559034150 type ExactKeys = Exclude extends never ? T1 : never; @@ -215,9 +214,7 @@ export const extractEventFiltetrsPageLocation = ( }; }; -export const getEventFiltersListPath = ( - location?: Partial -): string => { +export const getEventFiltersListPath = (location?: Partial): string => { const path = generatePath(MANAGEMENT_ROUTING_EVENT_FILTERS_PATH, { tabName: AdministrationSubTab.eventFilters, }); diff --git a/x-pack/plugins/security_solution/public/management/pages/event_filters/service/index.ts b/x-pack/plugins/security_solution/public/management/pages/event_filters/service/index.ts index 9d186d590ca67..0c01cbfc6a24f 100644 --- a/x-pack/plugins/security_solution/public/management/pages/event_filters/service/index.ts +++ b/x-pack/plugins/security_solution/public/management/pages/event_filters/service/index.ts @@ -7,10 +7,13 @@ import { HttpStart } from 'kibana/public'; import { + ExceptionListItemSchema, CreateExceptionListItemSchema, ENDPOINT_EVENT_FILTERS_LIST_ID, - ExceptionListItemSchema, + UpdateExceptionListItemSchema, } from '../../../../shared_imports'; +import { Immutable } from '../../../../../common/endpoint/types'; + import { EVENT_FILTER_LIST, EXCEPTION_LIST_ITEM_URL, EXCEPTION_LIST_URL } from '../constants'; import { FoundExceptionListItemSchema } from '../../../../../../lists/common/schemas'; import { EventFiltersService } from '../types'; @@ -69,4 +72,21 @@ export class EventFiltersHttpService implements EventFiltersService { body: JSON.stringify(exception), }); } + + async getOne(id: string) { + return (await this.httpWrapper()).get(EXCEPTION_LIST_ITEM_URL, { + query: { + id, + namespace_type: 'agnostic', + }, + }); + } + + async updateOne( + exception: Immutable + ): Promise { + return (await this.httpWrapper()).put(EXCEPTION_LIST_ITEM_URL, { + body: JSON.stringify(exception), + }); + } } diff --git a/x-pack/plugins/security_solution/public/management/pages/event_filters/state/index.ts b/x-pack/plugins/security_solution/public/management/pages/event_filters/state/index.ts index 4bc90ce764ace..4a7788e0b9225 100644 --- a/x-pack/plugins/security_solution/public/management/pages/event_filters/state/index.ts +++ b/x-pack/plugins/security_solution/public/management/pages/event_filters/state/index.ts @@ -5,29 +5,18 @@ * 2.0. */ -import { ExceptionListItemSchema, CreateExceptionListItemSchema } from '../../../../shared_imports'; +import { ExceptionListItemSchema } from '../../../../shared_imports'; import { AsyncResourceState } from '../../../state/async_resource_state'; import { FoundExceptionListItemSchema } from '../../../../../../lists/common/schemas'; -import { EventFiltersServiceGetListOptions } from '../types'; - -export interface EventFiltersPageLocation { - page_index: number; - page_size: number; - show?: 'create' | 'edit'; - /** Used for editing. The ID of the selected event filter */ - id?: string; - filter: string; -} +import { + EventFiltersForm, + EventFiltersPageLocation, + EventFiltersServiceGetListOptions, +} from '../types'; export interface EventFiltersListPageState { entries: ExceptionListItemSchema[]; - form: { - entry: CreateExceptionListItemSchema | ExceptionListItemSchema | undefined; - hasNameError: boolean; - hasItemsError: boolean; - hasOSError: boolean; - submissionResourceState: AsyncResourceState; - }; + form: EventFiltersForm; location: EventFiltersPageLocation; /** State for the Event Filters List page */ listPage: { diff --git a/x-pack/plugins/security_solution/public/management/pages/event_filters/store/action.ts b/x-pack/plugins/security_solution/public/management/pages/event_filters/store/action.ts index 21c8ef63d3eb3..76cb6c570221c 100644 --- a/x-pack/plugins/security_solution/public/management/pages/event_filters/store/action.ts +++ b/x-pack/plugins/security_solution/public/management/pages/event_filters/store/action.ts @@ -6,7 +6,11 @@ */ import { Action } from 'redux'; -import { ExceptionListItemSchema, CreateExceptionListItemSchema } from '../../../../shared_imports'; +import { + ExceptionListItemSchema, + CreateExceptionListItemSchema, + UpdateExceptionListItemSchema, +} from '../../../../shared_imports'; import { AsyncResourceState } from '../../../state/async_resource_state'; import { EventFiltersListPageState } from '../state'; @@ -24,25 +28,30 @@ export type EventFiltersListPageDataExistsChanged = Action<'eventFiltersListPage export type EventFiltersInitForm = Action<'eventFiltersInitForm'> & { payload: { - entry: ExceptionListItemSchema | CreateExceptionListItemSchema; + entry: UpdateExceptionListItemSchema | CreateExceptionListItemSchema; + }; +}; + +export type EventFiltersInitFromId = Action<'eventFiltersInitFromId'> & { + payload: { + id: string; }; }; export type EventFiltersChangeForm = Action<'eventFiltersChangeForm'> & { payload: { - entry: ExceptionListItemSchema | CreateExceptionListItemSchema; + entry: UpdateExceptionListItemSchema | CreateExceptionListItemSchema; hasNameError?: boolean; hasItemsError?: boolean; hasOSError?: boolean; + newComment?: string; }; }; +export type EventFiltersUpdateStart = Action<'eventFiltersUpdateStart'>; +export type EventFiltersUpdateSuccess = Action<'eventFiltersUpdateSuccess'>; export type EventFiltersCreateStart = Action<'eventFiltersCreateStart'>; -export type EventFiltersCreateSuccess = Action<'eventFiltersCreateSuccess'> & { - payload: { - exception: ExceptionListItemSchema; - }; -}; +export type EventFiltersCreateSuccess = Action<'eventFiltersCreateSuccess'>; export type EventFiltersCreateError = Action<'eventFiltersCreateError'>; export type EventFiltersFormStateChanged = Action<'eventFiltersFormStateChanged'> & { @@ -53,9 +62,12 @@ export type EventFiltersPageAction = | EventFiltersListPageStateChanged | EventFiltersListPageDataChanged | EventFiltersListPageDataExistsChanged - | EventFiltersCreateStart | EventFiltersInitForm + | EventFiltersInitFromId | EventFiltersChangeForm + | EventFiltersUpdateStart + | EventFiltersUpdateSuccess + | EventFiltersCreateStart | EventFiltersCreateSuccess | EventFiltersCreateError | EventFiltersFormStateChanged; diff --git a/x-pack/plugins/security_solution/public/management/pages/event_filters/store/builders.ts b/x-pack/plugins/security_solution/public/management/pages/event_filters/store/builders.ts index 8d483c007fe64..460d5c2ce7398 100644 --- a/x-pack/plugins/security_solution/public/management/pages/event_filters/store/builders.ts +++ b/x-pack/plugins/security_solution/public/management/pages/event_filters/store/builders.ts @@ -15,6 +15,7 @@ export const initialEventFiltersPageState = (): EventFiltersListPageState => ({ hasNameError: false, hasItemsError: false, hasOSError: false, + newComment: '', submissionResourceState: { type: 'UninitialisedResourceState' }, }, location: { diff --git a/x-pack/plugins/security_solution/public/management/pages/event_filters/store/middleware.test.ts b/x-pack/plugins/security_solution/public/management/pages/event_filters/store/middleware.test.ts index cbd9b7bf0e538..2151762b04d03 100644 --- a/x-pack/plugins/security_solution/public/management/pages/event_filters/store/middleware.test.ts +++ b/x-pack/plugins/security_solution/public/management/pages/event_filters/store/middleware.test.ts @@ -14,6 +14,7 @@ import { import { AppAction } from '../../../../common/store/actions'; import { createEventFiltersPageMiddleware } from './middleware'; import { eventFiltersPageReducer } from './reducer'; + import { EventFiltersListPageState } from '../state'; import { initialEventFiltersPageState } from './builders'; import { getInitialExceptionFromEvent } from './utils'; @@ -25,6 +26,8 @@ const initialState: EventFiltersListPageState = initialEventFiltersPageState(); const createEventFiltersServiceMock = (): jest.Mocked => ({ addEventFilters: jest.fn(), getList: jest.fn(), + getOne: jest.fn(), + updateOne: jest.fn(), }); const createStoreSetup = (eventFiltersService: EventFiltersService) => { @@ -51,18 +54,18 @@ describe('middleware', () => { }); }); - describe('submit creation event filter', () => { - let service: jest.Mocked; - let store: Store; - let spyMiddleware: MiddlewareActionSpyHelper; - - beforeEach(() => { - service = createEventFiltersServiceMock(); - const storeSetup = createStoreSetup(service); - store = storeSetup.store as Store; - spyMiddleware = storeSetup.spyMiddleware; - }); + let service: jest.Mocked; + let store: Store; + let spyMiddleware: MiddlewareActionSpyHelper; + beforeEach(() => { + service = createEventFiltersServiceMock(); + const storeSetup = createStoreSetup(service); + store = storeSetup.store as Store; + spyMiddleware = storeSetup.spyMiddleware; + }); + + describe('submit creation event filter', () => { it('does not submit when entry is undefined', async () => { store.dispatch({ type: 'eventFiltersCreateStart' }); expect(store.getState()).toStrictEqual({ @@ -87,7 +90,6 @@ describe('middleware', () => { await spyMiddleware.waitForAction('eventFiltersFormStateChanged'); expect(store.getState()).toStrictEqual({ ...initialState, - entries: [createdEventFilterEntryMock()], form: { ...store.getState().form, submissionResourceState: { @@ -110,6 +112,108 @@ describe('middleware', () => { store.dispatch({ type: 'eventFiltersCreateStart' }); + await spyMiddleware.waitForAction('eventFiltersFormStateChanged'); + expect(store.getState()).toStrictEqual({ + ...initialState, + form: { + ...store.getState().form, + submissionResourceState: { + type: 'FailedResourceState', + lastLoadedState: undefined, + error: { + error: 'Internal Server Error', + message: 'error message', + statusCode: 500, + }, + }, + }, + }); + }); + }); + describe('load event filterby id', () => { + it('init form with an entry loaded by id from API', async () => { + service.getOne.mockResolvedValue(createdEventFilterEntryMock()); + store.dispatch({ type: 'eventFiltersInitFromId', payload: { id: 'id' } }); + await spyMiddleware.waitForAction('eventFiltersInitForm'); + expect(store.getState()).toStrictEqual({ + ...initialState, + form: { + ...store.getState().form, + entry: createdEventFilterEntryMock(), + }, + }); + }); + + it('does throw error when getting by id', async () => { + service.getOne.mockRejectedValue({ + body: { message: 'error message', statusCode: 500, error: 'Internal Server Error' }, + }); + store.dispatch({ type: 'eventFiltersInitFromId', payload: { id: 'id' } }); + await spyMiddleware.waitForAction('eventFiltersFormStateChanged'); + expect(store.getState()).toStrictEqual({ + ...initialState, + form: { + ...store.getState().form, + submissionResourceState: { + type: 'FailedResourceState', + lastLoadedState: undefined, + error: { + error: 'Internal Server Error', + message: 'error message', + statusCode: 500, + }, + }, + }, + }); + }); + }); + describe('submit update event filter', () => { + it('does not submit when entry is undefined', async () => { + store.dispatch({ type: 'eventFiltersUpdateStart' }); + expect(store.getState()).toStrictEqual({ + ...initialState, + form: { + ...store.getState().form, + submissionResourceState: { type: 'UninitialisedResourceState' }, + }, + }); + }); + + it('does submit when entry is not undefined', async () => { + service.updateOne.mockResolvedValue(createdEventFilterEntryMock()); + + store.dispatch({ + type: 'eventFiltersInitForm', + payload: { entry: createdEventFilterEntryMock() }, + }); + + store.dispatch({ type: 'eventFiltersUpdateStart' }); + + await spyMiddleware.waitForAction('eventFiltersFormStateChanged'); + expect(store.getState()).toStrictEqual({ + ...initialState, + form: { + ...store.getState().form, + submissionResourceState: { + type: 'LoadedResourceState', + data: createdEventFilterEntryMock(), + }, + }, + }); + }); + + it('does throw error when creating', async () => { + service.updateOne.mockRejectedValue({ + body: { message: 'error message', statusCode: 500, error: 'Internal Server Error' }, + }); + const entry = getInitialExceptionFromEvent(ecsEventMock()); + store.dispatch({ + type: 'eventFiltersInitForm', + payload: { entry }, + }); + + store.dispatch({ type: 'eventFiltersUpdateStart' }); + await spyMiddleware.waitForAction('eventFiltersFormStateChanged'); expect(store.getState()).toStrictEqual({ ...initialState, diff --git a/x-pack/plugins/security_solution/public/management/pages/event_filters/store/middleware.ts b/x-pack/plugins/security_solution/public/management/pages/event_filters/store/middleware.ts index 7aca45049f91a..f1cf3e49e4382 100644 --- a/x-pack/plugins/security_solution/public/management/pages/event_filters/store/middleware.ts +++ b/x-pack/plugins/security_solution/public/management/pages/event_filters/store/middleware.ts @@ -16,7 +16,13 @@ import { EventFiltersHttpService } from '../service'; import { EventFiltersListPageState } from '../state'; import { getLastLoadedResourceState } from '../../../state/async_resource_state'; -import { CreateExceptionListItemSchema, transformNewItemOutput } from '../../../../shared_imports'; + +import { + CreateExceptionListItemSchema, + transformNewItemOutput, + transformOutput, + UpdateExceptionListItemSchema, +} from '../../../../shared_imports'; import { getCurrentListPageDataState, getCurrentLocation, @@ -24,9 +30,23 @@ import { getListPageDataExistsState, getListPageIsActive, listDataNeedsRefresh, + getFormEntry, + getSubmissionResource, + getNewComment, } from './selector'; import { EventFiltersService, EventFiltersServiceGetListOptions } from '../types'; +const addNewComments = ( + entry: UpdateExceptionListItemSchema | CreateExceptionListItemSchema, + newComment: string +): UpdateExceptionListItemSchema | CreateExceptionListItemSchema => { + if (newComment) { + if (!entry.comments) entry.comments = []; + entry.comments.push({ comment: newComment }); + } + return entry; +}; + type MiddlewareActionHandler = ( store: ImmutableMiddlewareAPI, eventFiltersService: EventFiltersService @@ -35,7 +55,7 @@ type MiddlewareActionHandler = ( const eventFiltersCreate: MiddlewareActionHandler = async (store, eventFiltersService) => { const submissionResourceState = store.getState().form.submissionResourceState; try { - const formEntry = store.getState().form.entry; + const formEntry = getFormEntry(store.getState()); if (!formEntry) return; store.dispatch({ type: 'eventFiltersFormStateChanged', @@ -46,14 +66,83 @@ const eventFiltersCreate: MiddlewareActionHandler = async (store, eventFiltersSe }); const sanitizedEntry = transformNewItemOutput(formEntry as CreateExceptionListItemSchema); + const updatedCommentsEntry = addNewComments( + sanitizedEntry, + getNewComment(store.getState()) + ) as CreateExceptionListItemSchema; + + const exception = await eventFiltersService.addEventFilters(updatedCommentsEntry); - const exception = await eventFiltersService.addEventFilters(sanitizedEntry); store.dispatch({ type: 'eventFiltersCreateSuccess', + }); + + store.dispatch({ + type: 'eventFiltersFormStateChanged', + payload: { + type: 'LoadedResourceState', + data: exception, + }, + }); + } catch (error) { + store.dispatch({ + type: 'eventFiltersFormStateChanged', + payload: { + type: 'FailedResourceState', + error: error.body || error, + lastLoadedState: getLastLoadedResourceState(submissionResourceState), + }, + }); + } +}; + +const eventFiltersUpdate = async ( + store: ImmutableMiddlewareAPI, + eventFiltersService: EventFiltersService +) => { + const submissionResourceState = getSubmissionResource(store.getState()); + try { + const formEntry = getFormEntry(store.getState()); + if (!formEntry) return; + store.dispatch({ + type: 'eventFiltersFormStateChanged', payload: { - exception, + type: 'LoadingResourceState', + previousState: { type: 'UninitialisedResourceState' }, }, }); + + const sanitizedEntry: UpdateExceptionListItemSchema = transformOutput( + formEntry as UpdateExceptionListItemSchema + ); + const updatedCommentsEntry = addNewComments( + sanitizedEntry, + getNewComment(store.getState()) + ) as UpdateExceptionListItemSchema; + + // Clean unnecessary fields for update action + [ + 'created_at', + 'created_by', + 'created_at', + 'created_by', + 'list_id', + 'tie_breaker_id', + 'updated_at', + 'updated_by', + ].forEach((field) => { + delete updatedCommentsEntry[field as keyof UpdateExceptionListItemSchema]; + }); + + updatedCommentsEntry.comments = updatedCommentsEntry.comments?.map((comment) => ({ + comment: comment.comment, + id: comment.id, + })); + + const exception = await eventFiltersService.updateOne(updatedCommentsEntry); + store.dispatch({ + type: 'eventFiltersUpdateSuccess', + }); store.dispatch({ type: 'eventFiltersFormStateChanged', payload: { @@ -73,6 +162,30 @@ const eventFiltersCreate: MiddlewareActionHandler = async (store, eventFiltersSe } }; +const eventFiltersLoadById = async ( + store: ImmutableMiddlewareAPI, + eventFiltersService: EventFiltersService, + id: string +) => { + const submissionResourceState = getSubmissionResource(store.getState()); + try { + const entry = await eventFiltersService.getOne(id); + store.dispatch({ + type: 'eventFiltersInitForm', + payload: { entry }, + }); + } catch (error) { + store.dispatch({ + type: 'eventFiltersFormStateChanged', + payload: { + type: 'FailedResourceState', + error: error.body || error, + lastLoadedState: getLastLoadedResourceState(submissionResourceState), + }, + }); + } +}; + const checkIfEventFilterDataExist: MiddlewareActionHandler = async ( { dispatch, getState }, eventFiltersService: EventFiltersService @@ -146,6 +259,14 @@ const refreshListDataIfNeeded: MiddlewareActionHandler = async (store, eventFilt }, }); + dispatch({ + type: 'eventFiltersListPageDataExistsChanged', + payload: { + type: 'LoadedResourceState', + data: Boolean(results.total), + }, + }); + // If no results were returned, then just check to make sure data actually exists for // event filters. This is used to drive the UI between showing "empty state" and "no items found" // messages to the user @@ -172,11 +293,19 @@ export const createEventFiltersPageMiddleware = ( if (action.type === 'eventFiltersCreateStart') { await eventFiltersCreate(store, eventFiltersService); + } else if (action.type === 'eventFiltersInitFromId') { + await eventFiltersLoadById(store, eventFiltersService, action.payload.id); + } else if (action.type === 'eventFiltersUpdateStart') { + await eventFiltersUpdate(store, eventFiltersService); } // Middleware that only applies to the List Page for Event Filters if (getListPageIsActive(store.getState())) { - if (action.type === 'userChangedUrl' || action.type === 'eventFiltersCreateSuccess') { + if ( + action.type === 'userChangedUrl' || + action.type === 'eventFiltersCreateSuccess' || + action.type === 'eventFiltersUpdateSuccess' + ) { refreshListDataIfNeeded(store, eventFiltersService); } } diff --git a/x-pack/plugins/security_solution/public/management/pages/event_filters/store/reducer.test.ts b/x-pack/plugins/security_solution/public/management/pages/event_filters/store/reducer.test.ts index c78cb030fd3d3..3196ac0c19b28 100644 --- a/x-pack/plugins/security_solution/public/management/pages/event_filters/store/reducer.test.ts +++ b/x-pack/plugins/security_solution/public/management/pages/event_filters/store/reducer.test.ts @@ -37,9 +37,10 @@ describe('reducer', () => { it('change form values', () => { const entry = getInitialExceptionFromEvent(ecsEventMock()); const nameChanged = 'name changed'; + const newComment = 'new comment'; const result = eventFiltersPageReducer(initialState, { type: 'eventFiltersChangeForm', - payload: { entry: { ...entry, name: nameChanged } }, + payload: { entry: { ...entry, name: nameChanged }, newComment }, }); expect(result).toStrictEqual({ @@ -50,6 +51,7 @@ describe('reducer', () => { ...entry, name: nameChanged, }, + newComment, hasNameError: false, submissionResourceState: { type: 'UninitialisedResourceState', @@ -79,34 +81,22 @@ describe('reducer', () => { }); }); - it('create is success when there is no entry on entries list', () => { - const result = eventFiltersPageReducer(initialState, { + it('create is success and force list refresh', () => { + const initialStateWithListPageActive = { + ...initialState, + listPage: { ...initialState.listPage, active: true }, + }; + const result = eventFiltersPageReducer(initialStateWithListPageActive, { type: 'eventFiltersCreateSuccess', - payload: { - exception: createdEventFilterEntryMock(), - }, }); expect(result).toStrictEqual({ - ...initialState, - entries: [createdEventFilterEntryMock()], - }); - }); - - it('create is success when there there are entries on entries list', () => { - const customizedInitialState = { - ...initialState, - entries: [createdEventFilterEntryMock(), createdEventFilterEntryMock()], - }; - const result = eventFiltersPageReducer(customizedInitialState, { - type: 'eventFiltersCreateSuccess', - payload: { - exception: { ...createdEventFilterEntryMock(), meta: {} }, + ...initialStateWithListPageActive, + listPage: { + ...initialStateWithListPageActive.listPage, + forceRefresh: true, }, }); - - expect(result.entries).toHaveLength(3); - expect(result.entries[0]!.meta).not.toBeUndefined(); }); }); describe('UserChangedUrl', () => { diff --git a/x-pack/plugins/security_solution/public/management/pages/event_filters/store/reducer.ts b/x-pack/plugins/security_solution/public/management/pages/event_filters/store/reducer.ts index d9e7a3c6611e5..858d62ae67744 100644 --- a/x-pack/plugins/security_solution/public/management/pages/event_filters/store/reducer.ts +++ b/x-pack/plugins/security_solution/public/management/pages/event_filters/store/reducer.ts @@ -14,12 +14,14 @@ import { AppLocation, Immutable } from '../../../../../common/endpoint/types'; import { UserChangedUrl } from '../../../../common/store/routing/action'; import { MANAGEMENT_ROUTING_EVENT_FILTERS_PATH } from '../../../common/constants'; import { extractEventFiltetrsPageLocation } from '../../../common/routing'; +import { isUninitialisedResourceState } from '../../../state/async_resource_state'; import { EventFiltersInitForm, EventFiltersChangeForm, EventFiltersFormStateChanged, EventFiltersCreateSuccess, + EventFiltersUpdateSuccess, EventFiltersListPageStateChanged, EventFiltersListPageDataChanged, EventFiltersListPageDataExistsChanged, @@ -113,6 +115,8 @@ const eventFiltersChangeForm: CaseReducer = (state, acti : state.form.hasNameError, hasOSError: action.payload.hasOSError !== undefined ? action.payload.hasOSError : state.form.hasOSError, + newComment: + action.payload.newComment !== undefined ? action.payload.newComment : state.form.newComment, }, }; }; @@ -122,6 +126,8 @@ const eventFiltersFormStateChanged: CaseReducer = ...state, form: { ...state.form, + entry: isUninitialisedResourceState(action.payload) ? undefined : state.form.entry, + newComment: isUninitialisedResourceState(action.payload) ? '' : state.form.newComment, submissionResourceState: action.payload, }, }; @@ -130,7 +136,19 @@ const eventFiltersFormStateChanged: CaseReducer = const eventFiltersCreateSuccess: CaseReducer = (state, action) => { return { ...state, - entries: [action.payload.exception, ...state.entries], + // If we are on the List page, then force a refresh of data + listPage: getListPageIsActive(state) + ? { + ...state.listPage, + forceRefresh: true, + } + : state.listPage, + }; +}; + +const eventFiltersUpdateSuccess: CaseReducer = (state, action) => { + return { + ...state, // If we are on the List page, then force a refresh of data listPage: getListPageIsActive(state) ? { @@ -180,6 +198,8 @@ export const eventFiltersPageReducer: StateReducer = ( return eventFiltersFormStateChanged(state, action); case 'eventFiltersCreateSuccess': return eventFiltersCreateSuccess(state, action); + case 'eventFiltersUpdateSuccess': + return eventFiltersUpdateSuccess(state, action); case 'userChangedUrl': return userChangedUrl(state, action); } diff --git a/x-pack/plugins/security_solution/public/management/pages/event_filters/store/selector.ts b/x-pack/plugins/security_solution/public/management/pages/event_filters/store/selector.ts index 671e39bd3f950..b33383d683e90 100644 --- a/x-pack/plugins/security_solution/public/management/pages/event_filters/store/selector.ts +++ b/x-pack/plugins/security_solution/public/management/pages/event_filters/store/selector.ts @@ -4,16 +4,19 @@ * 2.0; you may not use this file except in compliance with the Elastic License * 2.0. */ - import { createSelector } from 'reselect'; import { Pagination } from '@elastic/eui'; + +import { EventFiltersServiceGetListOptions } from '../types'; + import { EventFiltersListPageState } from '../state'; -import { ExceptionListItemSchema, CreateExceptionListItemSchema } from '../../../../shared_imports'; +import { ExceptionListItemSchema } from '../../../../shared_imports'; import { ServerApiError } from '../../../../common/types'; import { isLoadingResourceState, isLoadedResourceState, isFailedResourceState, + isUninitialisedResourceState, } from '../../../state/async_resource_state'; import { FoundExceptionListItemSchema } from '../../../../../../lists/common/schemas'; import { @@ -21,7 +24,6 @@ import { MANAGEMENT_PAGE_SIZE_OPTIONS, } from '../../../common/constants'; import { Immutable } from '../../../../../common/endpoint/types'; -import { EventFiltersServiceGetListOptions } from '../types'; type StoreState = Immutable; type EventFiltersSelector = (state: StoreState) => T; @@ -121,12 +123,30 @@ export const getListPageDoesDataExist: EventFiltersSelector = createSel } ); -export const getFormEntry = ( +export const getFormEntryState: EventFiltersSelector = (state) => { + return state.form.entry; +}; +// Needed for form component as we modify the existing entry on exceptuionBuilder component +export const getFormEntryStateMutable = ( state: EventFiltersListPageState -): CreateExceptionListItemSchema | ExceptionListItemSchema | undefined => { +): EventFiltersListPageState['form']['entry'] => { return state.form.entry; }; +export const getFormEntry = createSelector(getFormEntryState, (entry) => entry); + +export const getNewCommentState: EventFiltersSelector = ( + state +) => { + return state.form.newComment; +}; + +export const getNewComment = createSelector(getNewCommentState, (newComment) => newComment); + +export const getHasNameError = (state: EventFiltersListPageState): boolean => { + return state.form.hasNameError; +}; + export const getFormHasError = (state: EventFiltersListPageState): boolean => { return state.form.hasItemsError || state.form.hasNameError || state.form.hasOSError; }; @@ -139,12 +159,27 @@ export const isCreationSuccessful = (state: EventFiltersListPageState): boolean return isLoadedResourceState(state.form.submissionResourceState); }; -export const getCreationError = (state: EventFiltersListPageState): ServerApiError | undefined => { +export const isUninitialisedForm = (state: EventFiltersListPageState): boolean => { + return isUninitialisedResourceState(state.form.submissionResourceState); +}; + +export const getActionError = (state: EventFiltersListPageState): ServerApiError | undefined => { const submissionResourceState = state.form.submissionResourceState; return isFailedResourceState(submissionResourceState) ? submissionResourceState.error : undefined; }; +export const getSubmissionResourceState: EventFiltersSelector< + StoreState['form']['submissionResourceState'] +> = (state) => { + return state.form.submissionResourceState; +}; + +export const getSubmissionResource = createSelector( + getSubmissionResourceState, + (submissionResourceState) => submissionResourceState +); + export const getCurrentLocation: EventFiltersSelector = (state) => state.location; diff --git a/x-pack/plugins/security_solution/public/management/pages/event_filters/store/selectors.test.ts b/x-pack/plugins/security_solution/public/management/pages/event_filters/store/selectors.test.ts index a058c95388faa..3c15bc57e6c06 100644 --- a/x-pack/plugins/security_solution/public/management/pages/event_filters/store/selectors.test.ts +++ b/x-pack/plugins/security_solution/public/management/pages/event_filters/store/selectors.test.ts @@ -10,6 +10,8 @@ import { getFormEntry, getFormHasError, getCurrentLocation, + getNewComment, + getHasNameError, getCurrentListPageState, getListPageIsActive, getCurrentListPageDataState, @@ -24,7 +26,8 @@ import { } from './selector'; import { ecsEventMock } from '../test_utils'; import { getInitialExceptionFromEvent } from './utils'; -import { EventFiltersListPageState, EventFiltersPageLocation } from '../state'; +import { EventFiltersPageLocation } from '../types'; +import { EventFiltersListPageState } from '../state'; import { MANAGEMENT_DEFAULT_PAGE, MANAGEMENT_DEFAULT_PAGE_SIZE } from '../../../common/constants'; import { getFoundExceptionListItemSchemaMock } from '../../../../../../lists/common/schemas/response/found_exception_list_item_schema.mock'; import { @@ -252,6 +255,31 @@ describe('event filters selectors', () => { expect(getFormEntry(state)).toBe(entry); }); }); + describe('getHasNameError()', () => { + it('returns false when there is no entry', () => { + expect(getHasNameError(initialState)).toBeFalsy(); + }); + it('returns true when entry with name error', () => { + const state = { + ...initialState, + form: { + ...initialState.form, + hasNameError: true, + }, + }; + expect(getHasNameError(state)).toBeTruthy(); + }); + it('returns false when entry with no name error', () => { + const state = { + ...initialState, + form: { + ...initialState.form, + hasNameError: false, + }, + }; + expect(getHasNameError(state)).toBeFalsy(); + }); + }); describe('getFormHasError()', () => { it('returns false when there is no entry', () => { expect(getFormHasError(initialState)).toBeFalsy(); @@ -327,4 +355,23 @@ describe('event filters selectors', () => { expect(getCurrentLocation(state)).toBe(expectedLocation); }); }); + describe('getNewComment()', () => { + it('returns new comment', () => { + const newComment = 'this is a new comment'; + const state = { + ...initialState, + form: { + ...initialState.form, + newComment, + }, + }; + expect(getNewComment(state)).toBe(newComment); + }); + it('returns empty comment', () => { + const state = { + ...initialState, + }; + expect(getNewComment(state)).toBe(''); + }); + }); }); diff --git a/x-pack/plugins/security_solution/public/management/pages/event_filters/test_utils/index.ts b/x-pack/plugins/security_solution/public/management/pages/event_filters/test_utils/index.ts index c38de842521f5..62f73ddfc57e1 100644 --- a/x-pack/plugins/security_solution/public/management/pages/event_filters/test_utils/index.ts +++ b/x-pack/plugins/security_solution/public/management/pages/event_filters/test_utils/index.ts @@ -83,7 +83,7 @@ export const createdEventFilterEntryMock = (): ExceptionListItemSchema => ({ name: 'Test', namespace_type: 'agnostic', os_types: ['windows'], - tags: [], + tags: ['policy:all'], tie_breaker_id: 'c42f3dbd-292f-49e8-83ab-158d024a4d8b', type: 'simple', updated_at: '2021-04-19T10:30:36.428Z', diff --git a/x-pack/plugins/security_solution/public/management/pages/event_filters/types.ts b/x-pack/plugins/security_solution/public/management/pages/event_filters/types.ts index cad24b9f6ccf6..b23d353c21e36 100644 --- a/x-pack/plugins/security_solution/public/management/pages/event_filters/types.ts +++ b/x-pack/plugins/security_solution/public/management/pages/event_filters/types.ts @@ -5,16 +5,31 @@ * 2.0. */ -import { Immutable } from '../../../../common/endpoint/types'; import { + UpdateExceptionListItemSchema, CreateExceptionListItemSchema, ExceptionListItemSchema, -} from '../../../../../lists/common'; +} from '../../../shared_imports'; +import { AsyncResourceState } from '../../state/async_resource_state'; +import { Immutable } from '../../../../common/endpoint/types'; import { FoundExceptionListItemSchema } from '../../../../../lists/common/schemas'; -export interface EventFiltersListPageUrlSearchParams { +export interface EventFiltersPageLocation { page_index: number; page_size: number; + show?: 'create' | 'edit'; + /** Used for editing. The ID of the selected event filter */ + id?: string; + filter: string; +} + +export interface EventFiltersForm { + entry: UpdateExceptionListItemSchema | CreateExceptionListItemSchema | undefined; + newComment: string; + hasNameError: boolean; + hasItemsError: boolean; + hasOSError: boolean; + submissionResourceState: AsyncResourceState; } export type EventFiltersServiceGetListOptions = Partial<{ @@ -30,4 +45,6 @@ export interface EventFiltersService { ): Promise; getList(options?: EventFiltersServiceGetListOptions): Promise; + getOne(id: string): Promise; + updateOne(exception: Immutable): Promise; } diff --git a/x-pack/plugins/security_solution/public/management/pages/event_filters/view/components/empty/index.tsx b/x-pack/plugins/security_solution/public/management/pages/event_filters/view/components/empty/index.tsx index 81a119af34e5b..e3c9532708871 100644 --- a/x-pack/plugins/security_solution/public/management/pages/event_filters/view/components/empty/index.tsx +++ b/x-pack/plugins/security_solution/public/management/pages/event_filters/view/components/empty/index.tsx @@ -11,8 +11,8 @@ import { EuiButton, EuiEmptyPrompt } from '@elastic/eui'; import { FormattedMessage } from '@kbn/i18n/react'; const EmptyPrompt = styled(EuiEmptyPrompt)` - ${({ theme }) => css` - max-width: ${theme.eui.euiBreakpoints.m}; + ${() => css` + max-width: 100%; `} `; diff --git a/x-pack/plugins/security_solution/public/management/pages/event_filters/view/components/flyout/index.test.tsx b/x-pack/plugins/security_solution/public/management/pages/event_filters/view/components/flyout/index.test.tsx index 045497e33e294..48e7f1a6f22d5 100644 --- a/x-pack/plugins/security_solution/public/management/pages/event_filters/view/components/flyout/index.test.tsx +++ b/x-pack/plugins/security_solution/public/management/pages/event_filters/view/components/flyout/index.test.tsx @@ -5,7 +5,7 @@ * 2.0. */ import React from 'react'; -import { EventFiltersFlyout } from '.'; +import { EventFiltersFlyout, EventFiltersFlyoutProps } from '.'; import * as reactTestingLibrary from '@testing-library/react'; import { fireEvent } from '@testing-library/dom'; import { @@ -18,8 +18,14 @@ import { CreateExceptionListItemSchema, ExceptionListItemSchema, } from '../../../../../../shared_imports'; +import { EventFiltersHttpService } from '../../../service'; +import { createdEventFilterEntryMock } from '../../../test_utils'; +import { getFormEntryState, isUninitialisedForm } from '../../../store/selector'; +import { EventFiltersListPageState } from '../../../state'; jest.mock('../form'); +jest.mock('../../../service'); + jest.mock('../../hooks', () => { const originalModule = jest.requireActual('../../hooks'); const useEventFiltersNotification = jest.fn().mockImplementation(() => {}); @@ -32,16 +38,31 @@ jest.mock('../../hooks', () => { let mockedContext: AppContextTestRender; let waitForAction: MiddlewareActionSpyHelper['waitForAction']; -let render: () => ReturnType; +let render: ( + props?: Partial +) => ReturnType; const act = reactTestingLibrary.act; let onCancelMock: jest.Mock; +const EventFiltersHttpServiceMock = EventFiltersHttpService as jest.Mock; +let getState: () => EventFiltersListPageState; describe('Event filter flyout', () => { + beforeAll(() => { + EventFiltersHttpServiceMock.mockImplementation(() => { + return { + getOne: () => createdEventFilterEntryMock(), + addEventFilters: () => createdEventFilterEntryMock(), + updateOne: () => createdEventFilterEntryMock(), + }; + }); + }); beforeEach(() => { mockedContext = createAppRootMockRenderer(); waitForAction = mockedContext.middlewareSpy.waitForAction; onCancelMock = jest.fn(); - render = () => mockedContext.render(); + getState = () => mockedContext.store.getState().management.eventFilters; + render = (props) => + mockedContext.render(); }); afterEach(() => reactTestingLibrary.cleanup()); @@ -59,10 +80,8 @@ describe('Event filter flyout', () => { await waitForAction('eventFiltersInitForm'); }); - expect(mockedContext.store.getState().management.eventFilters.form.entry).not.toBeUndefined(); - expect( - mockedContext.store.getState().management.eventFilters.form.entry!.entries[0].field - ).toBe(''); + expect(getFormEntryState(getState())).not.toBeUndefined(); + expect(getFormEntryState(getState())!.entries[0].field).toBe(''); }); it('should confirm form when button is disabled', () => { @@ -71,9 +90,7 @@ describe('Event filter flyout', () => { act(() => { fireEvent.click(confirmButton); }); - expect( - mockedContext.store.getState().management.eventFilters.form.submissionResourceState.type - ).toBe('UninitialisedResourceState'); + expect(isUninitialisedForm(getState())).toBeTruthy(); }); it('should confirm form when button is enabled', async () => { @@ -82,8 +99,7 @@ describe('Event filter flyout', () => { type: 'eventFiltersChangeForm', payload: { entry: { - ...(mockedContext.store.getState().management.eventFilters.form! - .entry as CreateExceptionListItemSchema), + ...(getState().form!.entry as CreateExceptionListItemSchema), name: 'test', os_types: ['windows'], }, @@ -97,9 +113,7 @@ describe('Event filter flyout', () => { fireEvent.click(confirmButton); await waitForAction('eventFiltersCreateSuccess'); }); - expect( - mockedContext.store.getState().management.eventFilters.form.submissionResourceState.type - ).toBe('UninitialisedResourceState'); + expect(isUninitialisedForm(getState())).toBeTruthy(); expect(confirmButton.hasAttribute('disabled')).toBeFalsy(); }); @@ -112,8 +126,7 @@ describe('Event filter flyout', () => { type: 'eventFiltersFormStateChanged', payload: { type: 'LoadedResourceState', - data: mockedContext.store.getState().management.eventFilters.form! - .entry as ExceptionListItemSchema, + data: getState().form!.entry as ExceptionListItemSchema, }, }); }); @@ -166,4 +179,22 @@ describe('Event filter flyout', () => { expect(onCancelMock).toHaveBeenCalledTimes(0); }); + + it('should renders correctly when id and edit type', () => { + const component = render({ id: 'fakeId', type: 'edit' }); + + expect(component.getAllByText('Update Endpoint Event Filter')).not.toBeNull(); + expect(component.getByText('cancel')).not.toBeNull(); + expect(component.getByText('Endpoint Security')).not.toBeNull(); + }); + + it('should dispatch action to init form store on mount with id', async () => { + await act(async () => { + render({ id: 'fakeId', type: 'edit' }); + await waitForAction('eventFiltersInitFromId'); + }); + + expect(getFormEntryState(getState())).not.toBeUndefined(); + expect(getFormEntryState(getState())!.item_id).toBe(createdEventFilterEntryMock().item_id); + }); }); diff --git a/x-pack/plugins/security_solution/public/management/pages/event_filters/view/components/flyout/index.tsx b/x-pack/plugins/security_solution/public/management/pages/event_filters/view/components/flyout/index.tsx index b7f760cba4b0c..c8443ee171d50 100644 --- a/x-pack/plugins/security_solution/public/management/pages/event_filters/view/components/flyout/index.tsx +++ b/x-pack/plugins/security_solution/public/management/pages/event_filters/view/components/flyout/index.tsx @@ -22,7 +22,6 @@ import { EuiFlexItem, } from '@elastic/eui'; import { AppAction } from '../../../../../../common/store/actions'; -import { Ecs } from '../../../../../../../common/ecs'; import { EventFiltersForm } from '../form'; import { useEventFiltersSelector, useEventFiltersNotification } from '../../hooks'; import { @@ -33,97 +32,125 @@ import { import { getInitialExceptionFromEvent } from '../../../store/utils'; export interface EventFiltersFlyoutProps { - data?: Ecs; + type?: 'create' | 'edit'; + id?: string; onCancel(): void; } -export const EventFiltersFlyout: React.FC = memo(({ data, onCancel }) => { - useEventFiltersNotification(); - const dispatch = useDispatch>(); - const formHasError = useEventFiltersSelector(getFormHasError); - const creationInProgress = useEventFiltersSelector(isCreationInProgress); - const creationSuccessful = useEventFiltersSelector(isCreationSuccessful); +export const EventFiltersFlyout: React.FC = memo( + ({ onCancel, id, type = 'create' }) => { + useEventFiltersNotification(); + const dispatch = useDispatch>(); + const formHasError = useEventFiltersSelector(getFormHasError); + const creationInProgress = useEventFiltersSelector(isCreationInProgress); + const creationSuccessful = useEventFiltersSelector(isCreationSuccessful); - useEffect(() => { - if (creationSuccessful) { - onCancel(); - dispatch({ - type: 'eventFiltersFormStateChanged', - payload: { - type: 'UninitialisedResourceState', - }, - }); - } - }, [creationSuccessful, onCancel, dispatch]); - - // Initialize the store with the event passed as prop to allow render the form. It acts as componentDidMount - useEffect(() => { - dispatch({ - type: 'eventFiltersInitForm', - payload: { entry: getInitialExceptionFromEvent(data) }, - }); - // eslint-disable-next-line react-hooks/exhaustive-deps - }, []); + useEffect(() => { + if (creationSuccessful) { + onCancel(); + dispatch({ + type: 'eventFiltersFormStateChanged', + payload: { + type: 'UninitialisedResourceState', + }, + }); + } + }, [creationSuccessful, onCancel, dispatch]); - const handleOnCancel = useCallback(() => { - if (creationInProgress) return; - onCancel(); - }, [creationInProgress, onCancel]); + // Initialize the store with the id passed as prop to allow render the form. It acts as componentDidMount + useEffect(() => { + if (type === 'edit' && !!id) { + dispatch({ + type: 'eventFiltersInitFromId', + payload: { id }, + }); + } else { + dispatch({ + type: 'eventFiltersInitForm', + payload: { entry: getInitialExceptionFromEvent() }, + }); + } + // eslint-disable-next-line react-hooks/exhaustive-deps + }, []); - const confirmButtonMemo = useMemo( - () => ( - dispatch({ type: 'eventFiltersCreateStart' })} - isLoading={creationInProgress} - > - - - ), - [dispatch, formHasError, creationInProgress] - ); + const handleOnCancel = useCallback(() => { + if (creationInProgress) return; + onCancel(); + }, [creationInProgress, onCancel]); - return ( - - - -

+ const confirmButtonMemo = useMemo( + () => ( + + id + ? dispatch({ type: 'eventFiltersUpdateStart' }) + : dispatch({ type: 'eventFiltersCreateStart' }) + } + isLoading={creationInProgress} + > + {id ? ( -

- - - - - - - + ) : ( + + )} + + ), + [formHasError, creationInProgress, id, dispatch] + ); - - - - + return ( + + + +

- - - {confirmButtonMemo} - - - - ); -}); +

+ + {id ? ( + + ) : ( + + )} + + + + + + + + + + + + + + {confirmButtonMemo} + + + + ); + } +); EventFiltersFlyout.displayName = 'EventFiltersFlyout'; diff --git a/x-pack/plugins/security_solution/public/management/pages/event_filters/view/components/form/index.test.tsx b/x-pack/plugins/security_solution/public/management/pages/event_filters/view/components/form/index.test.tsx index d0d8ea12cf160..940882d079a12 100644 --- a/x-pack/plugins/security_solution/public/management/pages/event_filters/view/components/form/index.test.tsx +++ b/x-pack/plugins/security_solution/public/management/pages/event_filters/view/components/form/index.test.tsx @@ -111,8 +111,6 @@ describe('Event filter form', () => { }); }); - expect(store.getState()!.management!.eventFilters!.form!.entry!.comments![0].comment).toBe( - 'Exception comment' - ); + expect(store.getState()!.management!.eventFilters!.form!.newComment).toBe('Exception comment'); }); }); diff --git a/x-pack/plugins/security_solution/public/management/pages/event_filters/view/components/form/index.tsx b/x-pack/plugins/security_solution/public/management/pages/event_filters/view/components/form/index.tsx index 89832840a09d8..744fb9930321d 100644 --- a/x-pack/plugins/security_solution/public/management/pages/event_filters/view/components/form/index.tsx +++ b/x-pack/plugins/security_solution/public/management/pages/event_filters/view/components/form/index.tsx @@ -5,7 +5,7 @@ * 2.0. */ -import React, { memo, useMemo, useCallback, useState } from 'react'; +import React, { memo, useMemo, useCallback } from 'react'; import { useDispatch } from 'react-redux'; import { Dispatch } from 'redux'; import { @@ -18,7 +18,7 @@ import { EuiText, } from '@elastic/eui'; -import { isEmpty } from 'lodash'; +import { isEmpty } from 'lodash/fp'; import { OperatingSystem } from '../../../../../../../common/endpoint/types'; import { AddExceptionComments } from '../../../../../../common/components/exceptions/add_exception_comments'; import { filterIndexPatterns } from '../../../../../../common/components/exceptions/helpers'; @@ -29,7 +29,7 @@ import { AppAction } from '../../../../../../common/store/actions'; import { ExceptionListItemSchema, ExceptionBuilder } from '../../../../../../shared_imports'; import { useEventFiltersSelector } from '../../hooks'; -import { getFormEntry } from '../../../store/selector'; +import { getFormEntryStateMutable, getHasNameError, getNewComment } from '../../../store/selector'; import { FORM_DESCRIPTION, NAME_LABEL, @@ -54,7 +54,9 @@ export const EventFiltersForm: React.FC = memo( ({ allowSelectOs = false }) => { const { http, data } = useKibana().services; const dispatch = useDispatch>(); - const exception = useEventFiltersSelector(getFormEntry); + const exception = useEventFiltersSelector(getFormEntryStateMutable); + const hasNameError = useEventFiltersSelector(getHasNameError); + const newComment = useEventFiltersSelector(getNewComment); // This value has to be memoized to avoid infinite useEffect loop on useFetchIndex const indexNames = useMemo(() => ['logs-endpoint.events.*'], []); @@ -65,9 +67,6 @@ export const EventFiltersForm: React.FC = memo( [] ); - const [hasNameError, setHasNameError] = useState(!exception || !exception.name); - const [comment, setComment] = useState(''); - const handleOnBuilderChange = useCallback( (arg: ExceptionBuilder.OnChangeProps) => { if (isEmpty(arg.exceptionItems)) return; @@ -90,7 +89,6 @@ export const EventFiltersForm: React.FC = memo( const handleOnChangeName = useCallback( (e: React.ChangeEvent) => { if (!exception) return; - setHasNameError(!e.target.value); dispatch({ type: 'eventFiltersChangeForm', payload: { @@ -104,16 +102,16 @@ export const EventFiltersForm: React.FC = memo( const handleOnChangeComment = useCallback( (value: string) => { - setComment(value); if (!exception) return; dispatch({ type: 'eventFiltersChangeForm', payload: { - entry: { ...exception, comments: [{ comment: value }] }, + entry: exception, + newComment: value, }, }); }, - [dispatch, exception, setComment] + [dispatch, exception] ); const exceptionBuilderComponentMemo = useMemo( @@ -189,11 +187,12 @@ export const EventFiltersForm: React.FC = memo( const commentsInputMemo = useMemo( () => ( ), - [comment, handleOnChangeComment] + [exception, handleOnChangeComment, newComment] ); return !isIndexPatternLoading && exception ? ( diff --git a/x-pack/plugins/security_solution/public/management/pages/event_filters/view/event_filters_list_page.tsx b/x-pack/plugins/security_solution/public/management/pages/event_filters/view/event_filters_list_page.tsx index d32a4cbe1ca24..04a42370cbfa6 100644 --- a/x-pack/plugins/security_solution/public/management/pages/event_filters/view/event_filters_list_page.tsx +++ b/x-pack/plugins/security_solution/public/management/pages/event_filters/view/event_filters_list_page.tsx @@ -5,12 +5,19 @@ * 2.0. */ -import React, { memo, useCallback } from 'react'; +import React, { memo, useCallback, useEffect } from 'react'; +import { useDispatch } from 'react-redux'; +import { Dispatch } from 'redux'; +import { useHistory } from 'react-router-dom'; import { i18n } from '@kbn/i18n'; import { FormattedMessage } from '@kbn/i18n/react'; import { EuiButton } from '@elastic/eui'; import styled from 'styled-components'; + +import { AppAction } from '../../../../common/store/actions'; +import { getEventFiltersListPath } from '../../../common/routing'; import { AdministrationListPage as _AdministrationListPage } from '../../../components/administration_list_page'; + import { EventFiltersListEmptyState } from './components/empty'; import { useEventFiltersNavigateCallback, useEventFiltersSelector } from './hooks'; import { EventFiltersFlyout } from './components/flyout'; @@ -21,6 +28,8 @@ import { getListPagination, getCurrentLocation, getListPageDoesDataExist, + getActionError, + getFormEntry, } from '../store/selector'; import { PaginatedContent, PaginatedContentProps } from '../../../components/paginated_content'; import { ExceptionListItemSchema } from '../../../../../../lists/common'; @@ -46,6 +55,10 @@ const AdministrationListPage = styled(_AdministrationListPage)` `; export const EventFiltersListPage = memo(() => { + const history = useHistory(); + const dispatch = useDispatch>(); + const isActionError = useEventFiltersSelector(getActionError); + const formEntry = useEventFiltersSelector(getFormEntry); const listItems = useEventFiltersSelector(getListItems); const pagination = useEventFiltersSelector(getListPagination); const isLoading = useEventFiltersSelector(getListIsLoading); @@ -56,6 +69,35 @@ export const EventFiltersListPage = memo(() => { const navigateCallback = useEventFiltersNavigateCallback(); const showFlyout = !!location.show; + // Clean url params if wrong + useEffect(() => { + if ((location.show === 'edit' && !location.id) || (location.show === 'create' && !!location.id)) + navigateCallback({ + show: 'create', + id: undefined, + }); + }, [location, navigateCallback]); + + // Catch fetch error -> actionError + empty entry in form + useEffect(() => { + if (isActionError && !formEntry) { + // Replace the current URL route so that user does not keep hitting this page via browser back/fwd buttons + history.replace( + getEventFiltersListPath({ + ...location, + show: undefined, + id: undefined, + }) + ); + dispatch({ + type: 'eventFiltersFormStateChanged', + payload: { + type: 'UninitialisedResourceState', + }, + }); + } + }, [dispatch, formEntry, history, isActionError, location, navigateCallback]); + const handleAddButtonClick = useCallback( () => navigateCallback({ @@ -65,7 +107,7 @@ export const EventFiltersListPage = memo(() => { [navigateCallback] ); - const handleAddCancelButtonClick = useCallback( + const handleCancelButtonClick = useCallback( () => navigateCallback({ show: undefined, @@ -74,9 +116,15 @@ export const EventFiltersListPage = memo(() => { [navigateCallback] ); - const handleItemEdit: ExceptionItemProps['onEditException'] = useCallback((item) => { - // TODO: implement edit item - }, []); + const handleItemEdit: ExceptionItemProps['onEditException'] = useCallback( + (item: ExceptionListItemSchema) => { + navigateCallback({ + show: 'edit', + id: item.id, + }); + }, + [navigateCallback] + ); const handleItemDelete: ExceptionItemProps['onDeleteException'] = useCallback((args) => { // TODO: implement delete item @@ -136,7 +184,13 @@ export const EventFiltersListPage = memo(() => { ) } > - {showFlyout && } + {showFlyout && ( + + )} , typeof ExceptionItem> items={listItems} diff --git a/x-pack/plugins/security_solution/public/management/pages/event_filters/view/hooks.ts b/x-pack/plugins/security_solution/public/management/pages/event_filters/view/hooks.ts index bf2e187c127c2..65be130160601 100644 --- a/x-pack/plugins/security_solution/public/management/pages/event_filters/view/hooks.ts +++ b/x-pack/plugins/security_solution/public/management/pages/event_filters/view/hooks.ts @@ -11,16 +11,23 @@ import { useHistory } from 'react-router-dom'; import { isCreationSuccessful, - getFormEntry, - getCreationError, + getFormEntryStateMutable, + getActionError, getCurrentLocation, } from '../store/selector'; import { useToasts } from '../../../../common/lib/kibana'; -import { getCreationSuccessMessage, getCreationErrorMessage } from './translations'; +import { + getCreationSuccessMessage, + getUpdateSuccessMessage, + getCreationErrorMessage, + getUpdateErrorMessage, + getGetErrorMessage, +} from './translations'; import { State } from '../../../../common/store'; -import { EventFiltersListPageState, EventFiltersPageLocation } from '../state'; +import { EventFiltersListPageState } from '../state'; +import { EventFiltersPageLocation } from '../types'; import { getEventFiltersListPath } from '../../../common/routing'; import { @@ -36,17 +43,27 @@ export function useEventFiltersSelector(selector: (state: EventFiltersListPag export const useEventFiltersNotification = () => { const creationSuccessful = useEventFiltersSelector(isCreationSuccessful); - const creationError = useEventFiltersSelector(getCreationError); - const formEntry = useEventFiltersSelector(getFormEntry); + const actionError = useEventFiltersSelector(getActionError); + const formEntry = useEventFiltersSelector(getFormEntryStateMutable); const toasts = useToasts(); const [wasAlreadyHandled] = useState(new WeakSet()); if (creationSuccessful && formEntry && !wasAlreadyHandled.has(formEntry)) { wasAlreadyHandled.add(formEntry); - toasts.addSuccess(getCreationSuccessMessage(formEntry)); - } else if (creationError && !wasAlreadyHandled.has(creationError)) { - wasAlreadyHandled.add(creationError); - toasts.addDanger(getCreationErrorMessage(creationError)); + if (formEntry.item_id) { + toasts.addSuccess(getUpdateSuccessMessage(formEntry)); + } else { + toasts.addSuccess(getCreationSuccessMessage(formEntry)); + } + } else if (actionError && !wasAlreadyHandled.has(actionError)) { + wasAlreadyHandled.add(actionError); + if (formEntry && formEntry.item_id) { + toasts.addDanger(getUpdateErrorMessage(actionError)); + } else if (formEntry) { + toasts.addDanger(getCreationErrorMessage(actionError)); + } else { + toasts.addWarning(getGetErrorMessage(actionError)); + } } }; diff --git a/x-pack/plugins/security_solution/public/management/pages/event_filters/view/translations.ts b/x-pack/plugins/security_solution/public/management/pages/event_filters/view/translations.ts index 711ab8224ea60..248e69cc6866a 100644 --- a/x-pack/plugins/security_solution/public/management/pages/event_filters/view/translations.ts +++ b/x-pack/plugins/security_solution/public/management/pages/event_filters/view/translations.ts @@ -7,21 +7,47 @@ import { i18n } from '@kbn/i18n'; -import { ExceptionListItemSchema, CreateExceptionListItemSchema } from '../../../../shared_imports'; +import { + CreateExceptionListItemSchema, + UpdateExceptionListItemSchema, +} from '../../../../shared_imports'; import { ServerApiError } from '../../../../common/types'; export const getCreationSuccessMessage = ( - entry: CreateExceptionListItemSchema | ExceptionListItemSchema | undefined + entry: CreateExceptionListItemSchema | UpdateExceptionListItemSchema | undefined ) => { - return i18n.translate('xpack.securitySolution.eventFilter.form.successToastTitle', { + return i18n.translate('xpack.securitySolution.eventFilter.form.creationSuccessToastTitle', { defaultMessage: '"{name}" has been added to the event exceptions list.', values: { name: entry?.name }, }); }; +export const getUpdateSuccessMessage = ( + entry: CreateExceptionListItemSchema | UpdateExceptionListItemSchema | undefined +) => { + return i18n.translate('xpack.securitySolution.eventFilter.form.updateSuccessToastTitle', { + defaultMessage: '"{name}" has been updated successfully.', + values: { name: entry?.name }, + }); +}; + export const getCreationErrorMessage = (creationError: ServerApiError) => { - return i18n.translate('xpack.securitySolution.eventFilter.form.failedToastTitle', { + return i18n.translate('xpack.securitySolution.eventFilter.form.failedToastTitle.create', { defaultMessage: 'There was an error creating the new exception: "{error}"', values: { error: creationError.message }, }); }; + +export const getUpdateErrorMessage = (updateError: ServerApiError) => { + return i18n.translate('xpack.securitySolution.eventFilter.form.failedToastTitle.update', { + defaultMessage: 'There was an error updating the exception: "{error}"', + values: { error: updateError.message }, + }); +}; + +export const getGetErrorMessage = (getError: ServerApiError) => { + return i18n.translate('xpack.securitySolution.eventFilter.form.failedToastTitle.get', { + defaultMessage: 'Unable to edit trusted application: "{error}"', + values: { error: getError.message }, + }); +}; diff --git a/x-pack/plugins/security_solution/public/management/pages/event_filters/view/use_event_filters_notification.test.tsx b/x-pack/plugins/security_solution/public/management/pages/event_filters/view/use_event_filters_notification.test.tsx index 37f7dff8408a7..5dcb3fa6a12af 100644 --- a/x-pack/plugins/security_solution/public/management/pages/event_filters/view/use_event_filters_notification.test.tsx +++ b/x-pack/plugins/security_solution/public/management/pages/event_filters/view/use_event_filters_notification.test.tsx @@ -14,9 +14,19 @@ import { coreMock } from '../../../../../../../../src/core/public/mocks'; import { KibanaContextProvider } from '../../../../../../../../src/plugins/kibana_react/public/context'; import { CreateExceptionListItemSchema, ExceptionListItemSchema } from '../../../../shared_imports'; -import { createGlobalNoMiddlewareStore, ecsEventMock } from '../test_utils'; +import { + createdEventFilterEntryMock, + createGlobalNoMiddlewareStore, + ecsEventMock, +} from '../test_utils'; import { useEventFiltersNotification } from './hooks'; -import { getCreationErrorMessage, getCreationSuccessMessage } from './translations'; +import { + getCreationErrorMessage, + getCreationSuccessMessage, + getGetErrorMessage, + getUpdateSuccessMessage, + getUpdateErrorMessage, +} from './translations'; import { getInitialExceptionFromEvent } from '../store/utils'; import { getLastLoadedResourceState, @@ -79,6 +89,37 @@ describe('EventFiltersNotification', () => { expect(notifications.toasts.addDanger).not.toBeCalled(); }); + it('shows success notification when update successful', () => { + const store = createGlobalNoMiddlewareStore(); + const notifications = mockNotifications(); + + renderNotifications(store, notifications); + + act(() => { + store.dispatch({ + type: 'eventFiltersInitForm', + payload: { entry: createdEventFilterEntryMock() }, + }); + }); + + act(() => { + store.dispatch({ + type: 'eventFiltersFormStateChanged', + payload: { + type: 'LoadedResourceState', + data: store.getState()!.management!.eventFilters!.form!.entry as ExceptionListItemSchema, + }, + }); + }); + + expect(notifications.toasts.addSuccess).toBeCalledWith( + getUpdateSuccessMessage( + store.getState()!.management!.eventFilters!.form!.entry as CreateExceptionListItemSchema + ) + ); + expect(notifications.toasts.addDanger).not.toBeCalled(); + }); + it('shows error notification when creation fails', () => { const store = createGlobalNoMiddlewareStore(); const notifications = mockNotifications(); @@ -114,4 +155,67 @@ describe('EventFiltersNotification', () => { ) ); }); + + it('shows error notification when update fails', () => { + const store = createGlobalNoMiddlewareStore(); + const notifications = mockNotifications(); + + renderNotifications(store, notifications); + + act(() => { + store.dispatch({ + type: 'eventFiltersInitForm', + payload: { entry: createdEventFilterEntryMock() }, + }); + }); + + act(() => { + store.dispatch({ + type: 'eventFiltersFormStateChanged', + payload: { + type: 'FailedResourceState', + error: { message: 'error message', statusCode: 500, error: 'error' }, + lastLoadedState: getLastLoadedResourceState( + store.getState()!.management!.eventFilters!.form!.submissionResourceState + ), + }, + }); + }); + + expect(notifications.toasts.addSuccess).not.toBeCalled(); + expect(notifications.toasts.addDanger).toBeCalledWith( + getUpdateErrorMessage( + (store.getState()!.management!.eventFilters!.form! + .submissionResourceState as FailedResourceState).error + ) + ); + }); + + it('shows error notification when get fails', () => { + const store = createGlobalNoMiddlewareStore(); + const notifications = mockNotifications(); + + renderNotifications(store, notifications); + + act(() => { + store.dispatch({ + type: 'eventFiltersFormStateChanged', + payload: { + type: 'FailedResourceState', + error: { message: 'error message', statusCode: 500, error: 'error' }, + lastLoadedState: getLastLoadedResourceState( + store.getState()!.management!.eventFilters!.form!.submissionResourceState + ), + }, + }); + }); + + expect(notifications.toasts.addSuccess).not.toBeCalled(); + expect(notifications.toasts.addWarning).toBeCalledWith( + getGetErrorMessage( + (store.getState()!.management!.eventFilters!.form! + .submissionResourceState as FailedResourceState).error + ) + ); + }); }); diff --git a/x-pack/plugins/security_solution/public/shared_imports.ts b/x-pack/plugins/security_solution/public/shared_imports.ts index 4a1fdbf0564d1..e77c4a0eec486 100644 --- a/x-pack/plugins/security_solution/public/shared_imports.ts +++ b/x-pack/plugins/security_solution/public/shared_imports.ts @@ -60,4 +60,5 @@ export { withOptionalSignal, ExceptionBuilder, transformNewItemOutput, + transformOutput, } from '../../lists/public'; From 79be58ee1bacf855be868d9750d80c99e7d1e048 Mon Sep 17 00:00:00 2001 From: Jonathan Budzenski Date: Thu, 6 May 2021 11:14:31 -0500 Subject: [PATCH 02/20] Revert "[App Search] Remove reset mappings button from Role mappings (#99414)" This reverts commit 1d4bdc554cd7260e1543f71ad326d6ad518291b2. --- .../role_mappings/role_mappings.test.tsx | 37 +++++++++- .../role_mappings/role_mappings.tsx | 67 +++++++++++++++++-- .../role_mappings/role_mappings_logic.test.ts | 21 ++++++ .../role_mappings/role_mappings_logic.ts | 13 ++++ .../app_search/utils/role/types.ts | 3 + .../public/applications/shared/types.ts | 3 - .../routes/app_search/role_mappings.test.ts | 24 +++++++ .../server/routes/app_search/role_mappings.ts | 16 +++++ 8 files changed, 174 insertions(+), 10 deletions(-) diff --git a/x-pack/plugins/enterprise_search/public/applications/app_search/components/role_mappings/role_mappings.test.tsx b/x-pack/plugins/enterprise_search/public/applications/app_search/components/role_mappings/role_mappings.test.tsx index c6da903e20912..9275ba0cd16db 100644 --- a/x-pack/plugins/enterprise_search/public/applications/app_search/components/role_mappings/role_mappings.test.tsx +++ b/x-pack/plugins/enterprise_search/public/applications/app_search/components/role_mappings/role_mappings.test.tsx @@ -8,11 +8,11 @@ import '../../../__mocks__/shallow_useeffect.mock'; import { setMockActions, setMockValues } from '../../../__mocks__'; -import React from 'react'; +import React, { MouseEvent } from 'react'; -import { shallow } from 'enzyme'; +import { shallow, ShallowWrapper } from 'enzyme'; -import { EuiEmptyPrompt } from '@elastic/eui'; +import { EuiEmptyPrompt, EuiConfirmModal, EuiPageHeader } from '@elastic/eui'; import { Loading } from '../../../shared/loading'; import { RoleMappingsTable } from '../../../shared/role_mapping'; @@ -22,6 +22,7 @@ import { RoleMappings } from './role_mappings'; describe('RoleMappings', () => { const initializeRoleMappings = jest.fn(); + const handleResetMappings = jest.fn(); const mockValues = { roleMappings: [wsRoleMapping], dataLoading: false, @@ -31,6 +32,7 @@ describe('RoleMappings', () => { beforeEach(() => { setMockActions({ initializeRoleMappings, + handleResetMappings, }); setMockValues(mockValues); }); @@ -54,4 +56,33 @@ describe('RoleMappings', () => { expect(wrapper.find(EuiEmptyPrompt)).toHaveLength(1); }); + + describe('resetMappingsWarningModal', () => { + let wrapper: ShallowWrapper; + + beforeEach(() => { + wrapper = shallow(); + const button = wrapper.find(EuiPageHeader).prop('rightSideItems')![0] as any; + button.props.onClick(); + }); + + it('renders reset warnings modal', () => { + expect(wrapper.find(EuiConfirmModal)).toHaveLength(1); + }); + + it('hides reset warnings modal', () => { + const modal = wrapper.find(EuiConfirmModal); + modal.prop('onCancel')(); + + expect(wrapper.find(EuiConfirmModal)).toHaveLength(0); + }); + + it('resets when confirmed', () => { + const event = {} as MouseEvent; + const modal = wrapper.find(EuiConfirmModal); + modal.prop('onConfirm')!(event); + + expect(handleResetMappings).toHaveBeenCalled(); + }); + }); }); diff --git a/x-pack/plugins/enterprise_search/public/applications/app_search/components/role_mappings/role_mappings.tsx b/x-pack/plugins/enterprise_search/public/applications/app_search/components/role_mappings/role_mappings.tsx index 86e2e51d29a7d..e8d9e06142ef8 100644 --- a/x-pack/plugins/enterprise_search/public/applications/app_search/components/role_mappings/role_mappings.tsx +++ b/x-pack/plugins/enterprise_search/public/applications/app_search/components/role_mappings/role_mappings.tsx @@ -5,17 +5,22 @@ * 2.0. */ -import React, { useEffect } from 'react'; +import React, { useEffect, useState } from 'react'; import { useActions, useValues } from 'kea'; import { + EuiButton, + EuiConfirmModal, EuiEmptyPrompt, + EuiOverlayMask, EuiPageContent, EuiPageContentBody, EuiPageHeader, EuiPanel, } from '@elastic/eui'; +import { i18n } from '@kbn/i18n'; +import { FormattedMessage } from '@kbn/i18n/react'; import { FlashMessages } from '../../../shared/flash_messages'; import { SetAppSearchChrome as SetPageChrome } from '../../../shared/kibana_chrome'; @@ -29,12 +34,19 @@ import { import { ROLE_MAPPING_NEW_PATH } from '../../routes'; -import { ROLE_MAPPINGS_ENGINE_ACCESS_HEADING, EMPTY_ROLE_MAPPINGS_BODY } from './constants'; +import { + ROLE_MAPPINGS_ENGINE_ACCESS_HEADING, + EMPTY_ROLE_MAPPINGS_BODY, + ROLE_MAPPINGS_RESET_BUTTON, + ROLE_MAPPINGS_RESET_CONFIRM_TITLE, + ROLE_MAPPINGS_RESET_CONFIRM_BUTTON, + ROLE_MAPPINGS_RESET_CANCEL_BUTTON, +} from './constants'; import { RoleMappingsLogic } from './role_mappings_logic'; import { generateRoleMappingPath } from './utils'; export const RoleMappings: React.FC = () => { - const { initializeRoleMappings, resetState } = useActions(RoleMappingsLogic); + const { initializeRoleMappings, handleResetMappings, resetState } = useActions(RoleMappingsLogic); const { roleMappings, multipleAuthProvidersConfig, dataLoading } = useValues(RoleMappingsLogic); useEffect(() => { @@ -42,8 +54,28 @@ export const RoleMappings: React.FC = () => { return resetState; }, []); + const [isResetWarningVisible, setResetWarningVisibility] = useState(false); + const showWarning = () => setResetWarningVisibility(true); + const hideWarning = () => setResetWarningVisibility(false); + if (dataLoading) return ; + const RESET_MAPPINGS_WARNING_MODAL_BODY = ( + + {i18n.translate('xpack.enterpriseSearch.appSearch.resetMappingsWarningModalBodyBold', { + defaultMessage: 'All role mappings will be deleted', + })} + + ), + }} + /> + ); + const addMappingButton = ; const roleMappingEmptyState = ( @@ -68,16 +100,43 @@ export const RoleMappings: React.FC = () => { /> ); + const resetMappings = ( + + {ROLE_MAPPINGS_RESET_BUTTON} + + ); + + const resetMappingsWarningModal = isResetWarningVisible ? ( + + handleResetMappings(hideWarning)} + title={ROLE_MAPPINGS_RESET_CONFIRM_TITLE} + cancelButtonText={ROLE_MAPPINGS_RESET_CANCEL_BUTTON} + confirmButtonText={ROLE_MAPPINGS_RESET_CONFIRM_BUTTON} + buttonColor="danger" + maxWidth={640} + > +

{RESET_MAPPINGS_WARNING_MODAL_BODY}

+ + + ) : null; + return ( <> - + 0}> {roleMappings.length === 0 ? roleMappingEmptyState : roleMappingsTable} + {resetMappingsWarningModal} ); }; diff --git a/x-pack/plugins/enterprise_search/public/applications/app_search/components/role_mappings/role_mappings_logic.test.ts b/x-pack/plugins/enterprise_search/public/applications/app_search/components/role_mappings/role_mappings_logic.test.ts index ada17fc9a732a..fa51c0036d0db 100644 --- a/x-pack/plugins/enterprise_search/public/applications/app_search/components/role_mappings/role_mappings_logic.test.ts +++ b/x-pack/plugins/enterprise_search/public/applications/app_search/components/role_mappings/role_mappings_logic.test.ts @@ -311,6 +311,27 @@ describe('RoleMappingsLogic', () => { }); }); + describe('handleResetMappings', () => { + const callback = jest.fn(); + it('calls API and executes callback', async () => { + http.post.mockReturnValue(Promise.resolve({})); + RoleMappingsLogic.actions.handleResetMappings(callback); + + expect(http.post).toHaveBeenCalledWith('/api/app_search/role_mappings/reset'); + await nextTick(); + expect(callback).toHaveBeenCalled(); + }); + + it('handles error', async () => { + http.post.mockReturnValue(Promise.reject('this is an error')); + RoleMappingsLogic.actions.handleResetMappings(callback); + await nextTick(); + + expect(flashAPIErrors).toHaveBeenCalledWith('this is an error'); + expect(callback).toHaveBeenCalled(); + }); + }); + describe('handleSaveMapping', () => { const body = { roleType: 'owner', diff --git a/x-pack/plugins/enterprise_search/public/applications/app_search/components/role_mappings/role_mappings_logic.ts b/x-pack/plugins/enterprise_search/public/applications/app_search/components/role_mappings/role_mappings_logic.ts index 00b944d91cbcb..d6d5677386330 100644 --- a/x-pack/plugins/enterprise_search/public/applications/app_search/components/role_mappings/role_mappings_logic.ts +++ b/x-pack/plugins/enterprise_search/public/applications/app_search/components/role_mappings/role_mappings_logic.ts @@ -64,6 +64,7 @@ interface RoleMappingsActions { engineName: string; selected: boolean; }; + handleResetMappings(callback: () => void): Function; handleRoleChange(roleType: RoleTypes): { roleType: RoleTypes }; handleSaveMapping(): void; initializeRoleMapping(roleId?: string): { roleId?: string }; @@ -112,6 +113,7 @@ export const RoleMappingsLogic = kea ({ roleId }), handleDeleteMapping: true, + handleResetMappings: (callback) => callback, handleSaveMapping: true, }, reducers: { @@ -296,6 +298,17 @@ export const RoleMappingsLogic = kea { + const { http } = HttpLogic.values; + try { + await http.post('/api/app_search/role_mappings/reset'); + actions.initializeRoleMappings(); + } catch (e) { + flashAPIErrors(e); + } finally { + callback(); + } + }, handleSaveMapping: async () => { const { http } = HttpLogic.values; const { navigateToUrl } = KibanaLogic.values; diff --git a/x-pack/plugins/enterprise_search/public/applications/app_search/utils/role/types.ts b/x-pack/plugins/enterprise_search/public/applications/app_search/utils/role/types.ts index 8aa58d08b96dd..0c3abd6909390 100644 --- a/x-pack/plugins/enterprise_search/public/applications/app_search/utils/role/types.ts +++ b/x-pack/plugins/enterprise_search/public/applications/app_search/utils/role/types.ts @@ -49,6 +49,9 @@ export interface Role { export interface ASRoleMapping extends RoleMapping { accessAllEngines: boolean; engines: Engine[]; + toolTip?: { + content: string; + }; } export interface AdvanceRoleType { diff --git a/x-pack/plugins/enterprise_search/public/applications/shared/types.ts b/x-pack/plugins/enterprise_search/public/applications/shared/types.ts index 2cdadc1c6b0d3..e807af6abaf50 100644 --- a/x-pack/plugins/enterprise_search/public/applications/shared/types.ts +++ b/x-pack/plugins/enterprise_search/public/applications/shared/types.ts @@ -31,7 +31,4 @@ export interface RoleMapping { authProvider: string[]; roleType: string; rules: RoleRules; - toolTip?: { - content: string; - }; } diff --git a/x-pack/plugins/enterprise_search/server/routes/app_search/role_mappings.test.ts b/x-pack/plugins/enterprise_search/server/routes/app_search/role_mappings.test.ts index a126d06f303b4..856004add0f73 100644 --- a/x-pack/plugins/enterprise_search/server/routes/app_search/role_mappings.test.ts +++ b/x-pack/plugins/enterprise_search/server/routes/app_search/role_mappings.test.ts @@ -11,6 +11,7 @@ import { registerRoleMappingsRoute, registerRoleMappingRoute, registerNewRoleMappingRoute, + registerResetRoleMappingRoute, } from './role_mappings'; const roleMappingBaseSchema = { @@ -183,4 +184,27 @@ describe('role mappings routes', () => { }); }); }); + + describe('GET /api/app_search/role_mappings/reset', () => { + let mockRouter: MockRouter; + + beforeEach(() => { + jest.clearAllMocks(); + mockRouter = new MockRouter({ + method: 'post', + path: '/api/app_search/role_mappings/reset', + }); + + registerResetRoleMappingRoute({ + ...mockDependencies, + router: mockRouter.router, + }); + }); + + it('creates a request handler', () => { + expect(mockRequestHandler.createRequest).toHaveBeenCalledWith({ + path: '/role_mappings/reset', + }); + }); + }); }); diff --git a/x-pack/plugins/enterprise_search/server/routes/app_search/role_mappings.ts b/x-pack/plugins/enterprise_search/server/routes/app_search/role_mappings.ts index 86e17b575e019..3bd3b3d904280 100644 --- a/x-pack/plugins/enterprise_search/server/routes/app_search/role_mappings.ts +++ b/x-pack/plugins/enterprise_search/server/routes/app_search/role_mappings.ts @@ -107,8 +107,24 @@ export function registerNewRoleMappingRoute({ ); } +export function registerResetRoleMappingRoute({ + router, + enterpriseSearchRequestHandler, +}: RouteDependencies) { + router.post( + { + path: '/api/app_search/role_mappings/reset', + validate: false, + }, + enterpriseSearchRequestHandler.createRequest({ + path: '/role_mappings/reset', + }) + ); +} + export const registerRoleMappingsRoutes = (dependencies: RouteDependencies) => { registerRoleMappingsRoute(dependencies); registerRoleMappingRoute(dependencies); registerNewRoleMappingRoute(dependencies); + registerResetRoleMappingRoute(dependencies); }; From 33892741c34d002b3ba568d3ce5422632997c445 Mon Sep 17 00:00:00 2001 From: Matthias Wilhelm Date: Thu, 6 May 2021 18:54:57 +0200 Subject: [PATCH 03/20] [Discover] Rename Legacy table to Classic table and Data grid to New table (#99336) * Rename "Legacy table" to "Classic table" * Rename "Data grid" to "New table" --- .../components/top_nav/open_options_popover.test.tsx | 4 ++-- .../components/top_nav/open_options_popover.tsx | 8 ++++---- src/plugins/discover/server/ui_settings.ts | 6 +++--- 3 files changed, 9 insertions(+), 9 deletions(-) diff --git a/src/plugins/discover/public/application/components/top_nav/open_options_popover.test.tsx b/src/plugins/discover/public/application/components/top_nav/open_options_popover.test.tsx index 406d2eb8eac4b..5b3d1656d77e7 100644 --- a/src/plugins/discover/public/application/components/top_nav/open_options_popover.test.tsx +++ b/src/plugins/discover/public/application/components/top_nav/open_options_popover.test.tsx @@ -35,7 +35,7 @@ import { OptionsPopover } from './open_options_popover'; test('should display the correct text if datagrid is selected', () => { const element = document.createElement('div'); const component = mountWithIntl(); - expect(findTestSubject(component, 'docTableMode').text()).toBe('Data grid'); + expect(findTestSubject(component, 'docTableMode').text()).toBe('New table'); }); test('should display the correct text if legacy table is selected', () => { @@ -45,5 +45,5 @@ test('should display the correct text if legacy table is selected', () => { uiSettings.set('doc_table:legacy', true); const element = document.createElement('div'); const component = mountWithIntl(); - expect(findTestSubject(component, 'docTableMode').text()).toBe('Legacy table'); + expect(findTestSubject(component, 'docTableMode').text()).toBe('Classic table'); }); diff --git a/src/plugins/discover/public/application/components/top_nav/open_options_popover.tsx b/src/plugins/discover/public/application/components/top_nav/open_options_popover.tsx index fb8d061bcf4a6..280144d400216 100644 --- a/src/plugins/discover/public/application/components/top_nav/open_options_popover.tsx +++ b/src/plugins/discover/public/application/components/top_nav/open_options_popover.tsx @@ -32,10 +32,10 @@ export function OptionsPopover(props: OptionsPopoverProps) { const mode = isLegacy ? i18n.translate('discover.openOptionsPopover.legacyTableText', { - defaultMessage: 'Legacy table', + defaultMessage: 'Classic table', }) : i18n.translate('discover.openOptionsPopover.dataGridText', { - defaultMessage: 'Data grid', + defaultMessage: 'New table', }); return ( @@ -64,7 +64,7 @@ export function OptionsPopover(props: OptionsPopoverProps) { @@ -74,7 +74,7 @@ export function OptionsPopover(props: OptionsPopoverProps) { href={addBasePath(`/app/management/kibana/settings?query=${DOC_TABLE_LEGACY}`)} > {i18n.translate('discover.openOptionsPopover.goToAdvancedSettings', { - defaultMessage: 'Go to Advanced Settings', + defaultMessage: 'Get started', })} diff --git a/src/plugins/discover/server/ui_settings.ts b/src/plugins/discover/server/ui_settings.ts index 3b34bbdbd54fd..39251d2136f44 100644 --- a/src/plugins/discover/server/ui_settings.ts +++ b/src/plugins/discover/server/ui_settings.ts @@ -155,13 +155,13 @@ export const getUiSettings: () => Record = () => ({ }, [DOC_TABLE_LEGACY]: { name: i18n.translate('discover.advancedSettings.docTableVersionName', { - defaultMessage: 'Use legacy table', + defaultMessage: 'Use classic table', }), value: true, description: i18n.translate('discover.advancedSettings.docTableVersionDescription', { defaultMessage: - 'Discover uses a new table layout that includes better data sorting, drag-and-drop columns, and a full screen ' + - 'view. Enable this option if you prefer to fall back to the legacy table.', + 'Discover uses a new table layout that includes better data sorting, drag-and-drop columns, and a full screen view. ' + + 'Turn on this option to use the classic table. Turn off to use the new table. ', }), category: ['discover'], schema: schema.boolean(), From a1954b43345b06b1171b2b29940a6922aa95861b Mon Sep 17 00:00:00 2001 From: John Dorlus Date: Thu, 6 May 2021 12:59:59 -0400 Subject: [PATCH 04/20] Changed Upgrade Assistant test to reflect hiding the UI (#96714) * Added test to verify the UI changes for hiding the app. * Running tests on repeat. * Tests passed. Removing only clause to allow full suite to run. * Skipping firefox. Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com> --- .../upgrade_assistant/upgrade_assistant.ts | 22 +++++++++++++------ 1 file changed, 15 insertions(+), 7 deletions(-) diff --git a/x-pack/test/functional/apps/upgrade_assistant/upgrade_assistant.ts b/x-pack/test/functional/apps/upgrade_assistant/upgrade_assistant.ts index 93955fb741044..693b898f46636 100644 --- a/x-pack/test/functional/apps/upgrade_assistant/upgrade_assistant.ts +++ b/x-pack/test/functional/apps/upgrade_assistant/upgrade_assistant.ts @@ -17,10 +17,11 @@ export default function upgradeAssistantFunctionalTests({ const security = getService('security'); const log = getService('log'); const retry = getService('retry'); + const testSubjects = getService('testSubjects'); - // Failing: See https://github.com/elastic/kibana/issues/86546 - describe.skip('Upgrade Checkup', function () { - this.tags('includeFirefox'); + // Updated for the hiding of the UA UI. + describe('Upgrade Checkup', function () { + this.tags('skipFirefox'); before(async () => { await esArchiver.load('empty_kibana'); @@ -33,11 +34,18 @@ export default function upgradeAssistantFunctionalTests({ await security.testUser.restoreDefaults(); }); - it('allows user to navigate to upgrade checkup', async () => { + it('Overview page', async () => { + await PageObjects.upgradeAssistant.navigateToPage(); + await retry.waitFor('Upgrade Assistant overview page to be visible', async () => { + return testSubjects.exists('comingSoonPrompt'); + }); + }); + + it.skip('allows user to navigate to upgrade checkup', async () => { await PageObjects.upgradeAssistant.navigateToPage(); }); - it('allows user to toggle deprecation logging', async () => { + it.skip('allows user to toggle deprecation logging', async () => { log.debug('expect initial state to be ON'); expect(await PageObjects.upgradeAssistant.deprecationLoggingEnabledLabel()).to.be('On'); expect(await PageObjects.upgradeAssistant.isDeprecationLoggingEnabled()).to.be(true); @@ -60,7 +68,7 @@ export default function upgradeAssistantFunctionalTests({ }); }); - it('allows user to open cluster tab', async () => { + it.skip('allows user to open cluster tab', async () => { await PageObjects.upgradeAssistant.navigateToPage(); await PageObjects.upgradeAssistant.clickTab('cluster'); expect(await PageObjects.upgradeAssistant.issueSummaryText()).to.be( @@ -68,7 +76,7 @@ export default function upgradeAssistantFunctionalTests({ ); }); - it('allows user to open indices tab', async () => { + it.skip('allows user to open indices tab', async () => { await PageObjects.upgradeAssistant.navigateToPage(); await PageObjects.upgradeAssistant.clickTab('indices'); expect(await PageObjects.upgradeAssistant.issueSummaryText()).to.be( From 7c432e3048cd8b61f8a52e9c3c4e85d36e825170 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Alejandro=20Fern=C3=A1ndez=20Haro?= Date: Thu, 6 May 2021 19:09:09 +0200 Subject: [PATCH 05/20] [Usage Collection] Report the number of SOs per type (#99344) Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com> --- api_docs/actions.json | 92 +- api_docs/alerting.json | 108 +- api_docs/apm.json | 83 +- api_docs/apm.mdx | 3 + api_docs/canvas.json | 32 +- api_docs/canvas.mdx | 5 + api_docs/cases.json | 7038 ++++++++++++++++- api_docs/cases.mdx | 31 + api_docs/cloud.json | 38 +- api_docs/core.json | 683 +- api_docs/core_application.json | 44 +- api_docs/core_chrome.json | 2 +- api_docs/core_http.json | 108 +- api_docs/core_saved_objects.json | 702 +- api_docs/dashboard.json | 224 +- api_docs/data.json | 657 +- api_docs/data_enhanced.json | 657 +- api_docs/data_enhanced.mdx | 14 - api_docs/data_query.json | 4 +- api_docs/data_search.json | 2266 +++--- api_docs/data_ui.json | 2 +- api_docs/dev_tools.json | 2 +- api_docs/discover.json | 31 +- api_docs/discover_enhanced.json | 10 +- api_docs/embeddable.json | 163 +- api_docs/embeddable.mdx | 3 + api_docs/embeddable_enhanced.json | 16 +- api_docs/es_ui_shared.json | 12 +- api_docs/expressions.json | 1459 ++-- api_docs/features.json | 22 +- api_docs/file_data_visualizer.json | 290 + api_docs/file_data_visualizer.mdx | 29 + api_docs/file_upload.json | 1252 +-- api_docs/file_upload.mdx | 3 - api_docs/fleet.json | 2230 +++--- api_docs/infra.json | 23 +- api_docs/kibana_react.json | 52 +- api_docs/lens.json | 229 +- api_docs/license_api_guard.json | 199 + api_docs/license_api_guard.mdx | 18 + api_docs/licensing.json | 4 +- api_docs/lists.json | 513 +- api_docs/maps.json | 384 +- api_docs/maps_ems.json | 98 +- api_docs/ml.json | 1556 ++-- api_docs/monitoring.json | 20 +- api_docs/observability.json | 832 +- api_docs/observability.mdx | 6 + api_docs/osquery.json | 38 +- api_docs/presentation_util.json | 969 ++- api_docs/presentation_util.mdx | 5 + api_docs/remote_clusters.json | 4 +- api_docs/reporting.json | 265 +- api_docs/reporting.mdx | 3 + api_docs/rule_registry.json | 859 +- api_docs/rule_registry.mdx | 24 +- api_docs/saved_objects_management.json | 78 +- api_docs/security.json | 166 +- api_docs/security.mdx | 4 +- api_docs/security_solution.json | 160 +- api_docs/security_solution.mdx | 3 - api_docs/share.json | 2 +- api_docs/task_manager.json | 50 +- api_docs/telemetry_collection_manager.json | 42 +- api_docs/telemetry_management_section.json | 4 +- api_docs/timelines.json | 12 +- api_docs/triggers_actions_ui.json | 52 +- api_docs/ui_actions.json | 2 +- api_docs/ui_actions_enhanced.json | 154 +- api_docs/vis_type_timeseries.json | 8 +- api_docs/visualizations.json | 593 +- docs/developer/plugin-list.asciidoc | 2 +- ...kibana-plugin-core-public.doclinksstart.md | 2 +- src/plugins/kibana_usage_collection/README.md | 26 +- .../server/collectors/index.ts | 5 +- .../kibana/get_saved_object_counts.test.ts | 60 - .../kibana/get_saved_object_counts.ts | 75 - .../kibana/kibana_usage_collector.ts | 76 - .../get_saved_object_counts.test.ts | 80 + .../get_saved_object_counts.ts | 31 + .../{kibana => saved_objects_counts}/index.ts | 1 + .../kibana_usage_collector.test.ts} | 54 +- .../kibana_usage_collector.ts | 110 + .../saved_objects_count_collector.test.ts | 66 + .../saved_objects_count_collector.ts | 60 + .../server/plugin.test.ts | 4 + .../kibana_usage_collection/server/plugin.ts | 10 +- src/plugins/telemetry/schema/oss_plugins.json | 163 +- .../apis/telemetry/telemetry_local.ts | 9 + 89 files changed, 18034 insertions(+), 8546 deletions(-) create mode 100644 api_docs/file_data_visualizer.json create mode 100644 api_docs/file_data_visualizer.mdx create mode 100644 api_docs/license_api_guard.json create mode 100644 api_docs/license_api_guard.mdx delete mode 100644 src/plugins/kibana_usage_collection/server/collectors/kibana/get_saved_object_counts.test.ts delete mode 100644 src/plugins/kibana_usage_collection/server/collectors/kibana/get_saved_object_counts.ts delete mode 100644 src/plugins/kibana_usage_collection/server/collectors/kibana/kibana_usage_collector.ts create mode 100644 src/plugins/kibana_usage_collection/server/collectors/saved_objects_counts/get_saved_object_counts.test.ts create mode 100644 src/plugins/kibana_usage_collection/server/collectors/saved_objects_counts/get_saved_object_counts.ts rename src/plugins/kibana_usage_collection/server/collectors/{kibana => saved_objects_counts}/index.ts (82%) rename src/plugins/kibana_usage_collection/server/collectors/{kibana/index.test.ts => saved_objects_counts/kibana_usage_collector.test.ts} (54%) create mode 100644 src/plugins/kibana_usage_collection/server/collectors/saved_objects_counts/kibana_usage_collector.ts create mode 100644 src/plugins/kibana_usage_collection/server/collectors/saved_objects_counts/saved_objects_count_collector.test.ts create mode 100644 src/plugins/kibana_usage_collection/server/collectors/saved_objects_counts/saved_objects_count_collector.ts diff --git a/api_docs/actions.json b/api_docs/actions.json index 1a92e7270d4fb..7205080cf768e 100644 --- a/api_docs/actions.json +++ b/api_docs/actions.json @@ -148,6 +148,20 @@ "lineNumber": 65 } }, + { + "tags": [], + "id": "def-server.ActionResult.isMissingSecrets", + "type": "CompoundType", + "label": "isMissingSecrets", + "description": [], + "source": { + "path": "x-pack/plugins/actions/server/types.ts", + "lineNumber": 66 + }, + "signature": [ + "boolean | undefined" + ] + }, { "tags": [], "id": "def-server.ActionResult.config", @@ -156,7 +170,7 @@ "description": [], "source": { "path": "x-pack/plugins/actions/server/types.ts", - "lineNumber": 66 + "lineNumber": 67 }, "signature": [ "Config | undefined" @@ -170,7 +184,7 @@ "description": [], "source": { "path": "x-pack/plugins/actions/server/types.ts", - "lineNumber": 67 + "lineNumber": 68 } } ], @@ -316,7 +330,7 @@ "description": [], "source": { "path": "x-pack/plugins/actions/server/types.ts", - "lineNumber": 101 + "lineNumber": 102 } }, { @@ -327,7 +341,7 @@ "description": [], "source": { "path": "x-pack/plugins/actions/server/types.ts", - "lineNumber": 102 + "lineNumber": 103 } }, { @@ -338,7 +352,7 @@ "description": [], "source": { "path": "x-pack/plugins/actions/server/types.ts", - "lineNumber": 103 + "lineNumber": 104 }, "signature": [ "number | undefined" @@ -352,7 +366,7 @@ "description": [], "source": { "path": "x-pack/plugins/actions/server/types.ts", - "lineNumber": 104 + "lineNumber": 105 }, "signature": [ "\"basic\" | \"standard\" | \"gold\" | \"platinum\" | \"enterprise\" | \"trial\"" @@ -366,7 +380,7 @@ "description": [], "source": { "path": "x-pack/plugins/actions/server/types.ts", - "lineNumber": 105 + "lineNumber": 106 }, "signature": [ "{ params?: ValidatorType | undefined; config?: ValidatorType | undefined; secrets?: ValidatorType | undefined; } | undefined" @@ -392,7 +406,7 @@ "description": [], "source": { "path": "x-pack/plugins/actions/server/types.ts", - "lineNumber": 111 + "lineNumber": 112 } }, { @@ -406,7 +420,7 @@ "description": [], "source": { "path": "x-pack/plugins/actions/server/types.ts", - "lineNumber": 112 + "lineNumber": 113 } }, { @@ -420,7 +434,7 @@ "description": [], "source": { "path": "x-pack/plugins/actions/server/types.ts", - "lineNumber": 113 + "lineNumber": 114 } } ], @@ -428,7 +442,7 @@ "returnComment": [], "source": { "path": "x-pack/plugins/actions/server/types.ts", - "lineNumber": 110 + "lineNumber": 111 } }, { @@ -439,7 +453,7 @@ "description": [], "source": { "path": "x-pack/plugins/actions/server/types.ts", - "lineNumber": 115 + "lineNumber": 116 }, "signature": [ "ExecutorType", @@ -449,7 +463,7 @@ ], "source": { "path": "x-pack/plugins/actions/server/types.ts", - "lineNumber": 95 + "lineNumber": 96 }, "initialIsOpen": false }, @@ -577,7 +591,7 @@ "description": [], "source": { "path": "x-pack/plugins/actions/server/types.ts", - "lineNumber": 74 + "lineNumber": 75 }, "signature": [ "Secrets" @@ -586,7 +600,7 @@ ], "source": { "path": "x-pack/plugins/actions/server/types.ts", - "lineNumber": 70 + "lineNumber": 71 }, "initialIsOpen": false } @@ -634,7 +648,7 @@ "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; }" + "{ 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; }" ], "initialIsOpen": false }, @@ -1009,7 +1023,7 @@ "description": [], "source": { "path": "x-pack/plugins/actions/server/plugin.ts", - "lineNumber": 88 + "lineNumber": 99 } } ], @@ -1017,13 +1031,13 @@ "returnComment": [], "source": { "path": "x-pack/plugins/actions/server/plugin.ts", - "lineNumber": 82 + "lineNumber": 93 } } ], "source": { "path": "x-pack/plugins/actions/server/plugin.ts", - "lineNumber": 81 + "lineNumber": 92 }, "lifecycle": "setup", "initialIsOpen": true @@ -1055,7 +1069,7 @@ "description": [], "source": { "path": "x-pack/plugins/actions/server/plugin.ts", - "lineNumber": 93 + "lineNumber": 104 } }, { @@ -1073,13 +1087,13 @@ "description": [], "source": { "path": "x-pack/plugins/actions/server/plugin.ts", - "lineNumber": 93 + "lineNumber": 104 } } ], "source": { "path": "x-pack/plugins/actions/server/plugin.ts", - "lineNumber": 93 + "lineNumber": 104 } } ], @@ -1087,7 +1101,7 @@ "returnComment": [], "source": { "path": "x-pack/plugins/actions/server/plugin.ts", - "lineNumber": 93 + "lineNumber": 104 } }, { @@ -1110,7 +1124,7 @@ "description": [], "source": { "path": "x-pack/plugins/actions/server/plugin.ts", - "lineNumber": 95 + "lineNumber": 106 } }, { @@ -1124,7 +1138,7 @@ "description": [], "source": { "path": "x-pack/plugins/actions/server/plugin.ts", - "lineNumber": 96 + "lineNumber": 107 } }, { @@ -1142,13 +1156,13 @@ "description": [], "source": { "path": "x-pack/plugins/actions/server/plugin.ts", - "lineNumber": 97 + "lineNumber": 108 } } ], "source": { "path": "x-pack/plugins/actions/server/plugin.ts", - "lineNumber": 97 + "lineNumber": 108 } } ], @@ -1156,7 +1170,7 @@ "returnComment": [], "source": { "path": "x-pack/plugins/actions/server/plugin.ts", - "lineNumber": 94 + "lineNumber": 105 } }, { @@ -1202,7 +1216,7 @@ "description": [], "source": { "path": "x-pack/plugins/actions/server/plugin.ts", - "lineNumber": 99 + "lineNumber": 110 } } ], @@ -1210,7 +1224,7 @@ "returnComment": [], "source": { "path": "x-pack/plugins/actions/server/plugin.ts", - "lineNumber": 99 + "lineNumber": 110 } }, { @@ -1256,7 +1270,7 @@ "description": [], "source": { "path": "x-pack/plugins/actions/server/plugin.ts", - "lineNumber": 100 + "lineNumber": 111 } } ], @@ -1264,7 +1278,7 @@ "returnComment": [], "source": { "path": "x-pack/plugins/actions/server/plugin.ts", - "lineNumber": 100 + "lineNumber": 111 } }, { @@ -1275,7 +1289,7 @@ "description": [], "source": { "path": "x-pack/plugins/actions/server/plugin.ts", - "lineNumber": 101 + "lineNumber": 112 }, "signature": [ { @@ -1308,7 +1322,7 @@ "description": [], "source": { "path": "x-pack/plugins/actions/server/plugin.ts", - "lineNumber": 103 + "lineNumber": 114 } }, { @@ -1322,7 +1336,7 @@ "description": [], "source": { "path": "x-pack/plugins/actions/server/plugin.ts", - "lineNumber": 104 + "lineNumber": 115 } }, { @@ -1336,7 +1350,7 @@ "description": [], "source": { "path": "x-pack/plugins/actions/server/plugin.ts", - "lineNumber": 105 + "lineNumber": 116 } }, { @@ -1350,7 +1364,7 @@ "description": [], "source": { "path": "x-pack/plugins/actions/server/plugin.ts", - "lineNumber": 106 + "lineNumber": 117 } } ], @@ -1358,13 +1372,13 @@ "returnComment": [], "source": { "path": "x-pack/plugins/actions/server/plugin.ts", - "lineNumber": 102 + "lineNumber": 113 } } ], "source": { "path": "x-pack/plugins/actions/server/plugin.ts", - "lineNumber": 92 + "lineNumber": 103 }, "lifecycle": "start", "initialIsOpen": true diff --git a/api_docs/alerting.json b/api_docs/alerting.json index 803047ef9237d..9fb72c9f24abb 100644 --- a/api_docs/alerting.json +++ b/api_docs/alerting.json @@ -103,6 +103,40 @@ "server": { "classes": [], "functions": [ + { + "id": "def-server.getEsErrorMessage", + "type": "Function", + "children": [ + { + "id": "def-server.getEsErrorMessage.$1", + "type": "Object", + "label": "error", + "isRequired": true, + "signature": [ + "ElasticsearchError" + ], + "description": [], + "source": { + "path": "x-pack/plugins/alerting/server/lib/errors/es_error_parser.ts", + "lineNumber": 37 + } + } + ], + "signature": [ + "(error: ", + "ElasticsearchError", + ") => string" + ], + "description": [], + "label": "getEsErrorMessage", + "source": { + "path": "x-pack/plugins/alerting/server/lib/errors/es_error_parser.ts", + "lineNumber": 37 + }, + "tags": [], + "returnComment": [], + "initialIsOpen": false + }, { "id": "def-server.parseDuration", "type": "Function", @@ -211,7 +245,7 @@ "description": [], "source": { "path": "x-pack/plugins/alerting/server/types.ts", - "lineNumber": 85 + "lineNumber": 86 } }, { @@ -222,7 +256,7 @@ "description": [], "source": { "path": "x-pack/plugins/alerting/server/types.ts", - "lineNumber": 86 + "lineNumber": 87 }, "signature": [ "Date" @@ -236,7 +270,7 @@ "description": [], "source": { "path": "x-pack/plugins/alerting/server/types.ts", - "lineNumber": 87 + "lineNumber": 88 }, "signature": [ "Date | null" @@ -250,7 +284,7 @@ "description": [], "source": { "path": "x-pack/plugins/alerting/server/types.ts", - "lineNumber": 88 + "lineNumber": 89 }, "signature": [ { @@ -271,7 +305,7 @@ "description": [], "source": { "path": "x-pack/plugins/alerting/server/types.ts", - "lineNumber": 89 + "lineNumber": 90 }, "signature": [ "Params" @@ -285,7 +319,7 @@ "description": [], "source": { "path": "x-pack/plugins/alerting/server/types.ts", - "lineNumber": 90 + "lineNumber": 91 }, "signature": [ "State" @@ -299,7 +333,7 @@ "description": [], "source": { "path": "x-pack/plugins/alerting/server/types.ts", - "lineNumber": 91 + "lineNumber": 92 } }, { @@ -310,7 +344,7 @@ "description": [], "source": { "path": "x-pack/plugins/alerting/server/types.ts", - "lineNumber": 92 + "lineNumber": 93 }, "signature": [ "string | undefined" @@ -324,7 +358,7 @@ "description": [], "source": { "path": "x-pack/plugins/alerting/server/types.ts", - "lineNumber": 93 + "lineNumber": 94 } }, { @@ -335,7 +369,7 @@ "description": [], "source": { "path": "x-pack/plugins/alerting/server/types.ts", - "lineNumber": 94 + "lineNumber": 95 }, "signature": [ "string[]" @@ -349,7 +383,7 @@ "description": [], "source": { "path": "x-pack/plugins/alerting/server/types.ts", - "lineNumber": 95 + "lineNumber": 96 }, "signature": [ "string | null" @@ -363,7 +397,7 @@ "description": [], "source": { "path": "x-pack/plugins/alerting/server/types.ts", - "lineNumber": 96 + "lineNumber": 97 }, "signature": [ "string | null" @@ -372,7 +406,7 @@ ], "source": { "path": "x-pack/plugins/alerting/server/types.ts", - "lineNumber": 78 + "lineNumber": 79 }, "initialIsOpen": false }, @@ -443,6 +477,20 @@ }, ">" ] + }, + { + "tags": [], + "id": "def-server.AlertingApiRequestHandlerContext.areApiKeysEnabled", + "type": "Function", + "label": "areApiKeysEnabled", + "description": [], + "source": { + "path": "x-pack/plugins/alerting/server/types.ts", + "lineNumber": 49 + }, + "signature": [ + "() => Promise" + ] } ], "source": { @@ -466,7 +514,7 @@ "description": [], "source": { "path": "x-pack/plugins/alerting/server/types.ts", - "lineNumber": 219 + "lineNumber": 220 }, "signature": [ { @@ -486,7 +534,7 @@ "description": [], "source": { "path": "x-pack/plugins/alerting/server/types.ts", - "lineNumber": 220 + "lineNumber": 221 }, "signature": [ { @@ -501,7 +549,7 @@ ], "source": { "path": "x-pack/plugins/alerting/server/types.ts", - "lineNumber": 218 + "lineNumber": 219 }, "initialIsOpen": false }, @@ -531,7 +579,7 @@ "description": [], "source": { "path": "x-pack/plugins/alerting/server/types.ts", - "lineNumber": 73 + "lineNumber": 74 }, "signature": [ "(id: string) => Pick<", @@ -542,7 +590,7 @@ ], "source": { "path": "x-pack/plugins/alerting/server/types.ts", - "lineNumber": 68 + "lineNumber": 69 }, "initialIsOpen": false }, @@ -571,7 +619,7 @@ "description": [], "source": { "path": "x-pack/plugins/alerting/server/types.ts", - "lineNumber": 120 + "lineNumber": 121 } }, { @@ -582,7 +630,7 @@ "description": [], "source": { "path": "x-pack/plugins/alerting/server/types.ts", - "lineNumber": 121 + "lineNumber": 122 } }, { @@ -593,7 +641,7 @@ "description": [], "source": { "path": "x-pack/plugins/alerting/server/types.ts", - "lineNumber": 122 + "lineNumber": 123 }, "signature": [ "{ params?: ", @@ -609,7 +657,7 @@ "description": [], "source": { "path": "x-pack/plugins/alerting/server/types.ts", - "lineNumber": 125 + "lineNumber": 126 }, "signature": [ { @@ -630,7 +678,7 @@ "description": [], "source": { "path": "x-pack/plugins/alerting/server/types.ts", - "lineNumber": 126 + "lineNumber": 127 }, "signature": [ "ActionGroupIds" @@ -644,7 +692,7 @@ "description": [], "source": { "path": "x-pack/plugins/alerting/server/types.ts", - "lineNumber": 127 + "lineNumber": 128 }, "signature": [ { @@ -665,7 +713,7 @@ "description": [], "source": { "path": "x-pack/plugins/alerting/server/types.ts", - "lineNumber": 128 + "lineNumber": 129 }, "signature": [ "ExecutorType", @@ -688,7 +736,7 @@ "description": [], "source": { "path": "x-pack/plugins/alerting/server/types.ts", - "lineNumber": 139 + "lineNumber": 140 } }, { @@ -699,7 +747,7 @@ "description": [], "source": { "path": "x-pack/plugins/alerting/server/types.ts", - "lineNumber": 140 + "lineNumber": 141 }, "signature": [ "{ context?: ", @@ -737,7 +785,7 @@ "description": [], "source": { "path": "x-pack/plugins/alerting/server/types.ts", - "lineNumber": 145 + "lineNumber": 146 }, "signature": [ "\"basic\" | \"standard\" | \"gold\" | \"platinum\" | \"enterprise\" | \"trial\"" @@ -746,7 +794,7 @@ ], "source": { "path": "x-pack/plugins/alerting/server/types.ts", - "lineNumber": 112 + "lineNumber": 113 }, "initialIsOpen": false }, @@ -1138,7 +1186,7 @@ "description": [], "source": { "path": "x-pack/plugins/alerting/server/types.ts", - "lineNumber": 178 + "lineNumber": 179 }, "signature": [ "Pick, \"id\"> & Partial, \"enabled\" | \"name\" | \"params\" | \"actions\" | \"tags\" | \"muteAll\" | \"apiKey\" | \"alertTypeId\" | \"consumer\" | \"schedule\" | \"scheduledTaskId\" | \"createdBy\" | \"updatedBy\" | \"createdAt\" | \"updatedAt\" | \"apiKeyOwner\" | \"throttle\" | \"notifyWhen\" | \"mutedInstanceIds\" | \"executionStatus\">>" diff --git a/api_docs/apm.json b/api_docs/apm.json index e3d8747d7b465..cfe3b150db007 100644 --- a/api_docs/apm.json +++ b/api_docs/apm.json @@ -58,6 +58,22 @@ "enums": [], "misc": [], "objects": [], + "setup": { + "id": "def-public.ApmPluginSetup", + "type": "Type", + "label": "ApmPluginSetup", + "tags": [], + "description": [], + "source": { + "path": "x-pack/plugins/apm/public/plugin.ts", + "lineNumber": 48 + }, + "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\"; }; }>; }" + ], + "lifecycle": "setup", + "initialIsOpen": true + }, "start": { "id": "def-public.ApmPluginStart", "type": "Type", @@ -66,7 +82,7 @@ "description": [], "source": { "path": "x-pack/plugins/apm/public/plugin.ts", - "lineNumber": 45 + "lineNumber": 51 }, "signature": [ "void" @@ -140,7 +156,7 @@ "description": [], "source": { "path": "x-pack/plugins/apm/server/plugin.ts", - "lineNumber": 58 + "lineNumber": 60 } } ], @@ -148,7 +164,7 @@ "returnComment": [], "source": { "path": "x-pack/plugins/apm/server/plugin.ts", - "lineNumber": 58 + "lineNumber": 60 } }, { @@ -168,7 +184,7 @@ "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" @@ -195,7 +211,7 @@ "description": [], "source": { "path": "x-pack/plugins/apm/server/plugin.ts", - "lineNumber": 63 + "lineNumber": 65 } }, { @@ -206,12 +222,12 @@ "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 } } ], @@ -219,7 +235,7 @@ "returnComment": [], "source": { "path": "x-pack/plugins/apm/server/plugin.ts", - "lineNumber": 62 + "lineNumber": 64 } }, { @@ -256,7 +272,7 @@ "description": [], "source": { "path": "x-pack/plugins/apm/server/plugin.ts", - "lineNumber": 208 + "lineNumber": 200 } } ], @@ -264,7 +280,7 @@ "returnComment": [], "source": { "path": "x-pack/plugins/apm/server/plugin.ts", - "lineNumber": 208 + "lineNumber": 200 } }, { @@ -280,13 +296,13 @@ "returnComment": [], "source": { "path": "x-pack/plugins/apm/server/plugin.ts", - "lineNumber": 227 + "lineNumber": 219 } } ], "source": { "path": "x-pack/plugins/apm/server/plugin.ts", - "lineNumber": 48 + "lineNumber": 50 }, "initialIsOpen": false } @@ -361,7 +377,7 @@ "description": [], "source": { "path": "x-pack/plugins/apm/server/routes/typings.ts", - "lineNumber": 43 + "lineNumber": 46 }, "signature": [ { @@ -382,7 +398,7 @@ "description": [], "source": { "path": "x-pack/plugins/apm/server/routes/typings.ts", - "lineNumber": 44 + "lineNumber": 47 }, "signature": [ "ApmPluginRequestHandlerContext" @@ -396,7 +412,7 @@ "description": [], "source": { "path": "x-pack/plugins/apm/server/routes/typings.ts", - "lineNumber": 45 + "lineNumber": 48 }, "signature": [ "{ query: { _inspect: boolean; }; }" @@ -410,7 +426,7 @@ "description": [], "source": { "path": "x-pack/plugins/apm/server/routes/typings.ts", - "lineNumber": 50 + "lineNumber": 53 }, "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': ", @@ -426,7 +442,7 @@ "description": [], "source": { "path": "x-pack/plugins/apm/server/routes/typings.ts", - "lineNumber": 51 + "lineNumber": 54 }, "signature": [ "Logger" @@ -440,7 +456,7 @@ "description": [], "source": { "path": "x-pack/plugins/apm/server/routes/typings.ts", - "lineNumber": 52 + "lineNumber": 55 }, "signature": [ "{ setup: ", @@ -470,7 +486,7 @@ "description": [], "source": { "path": "x-pack/plugins/apm/server/routes/typings.ts", - "lineNumber": 56 + "lineNumber": 59 }, "signature": [ "{ data: { setup: ", @@ -505,20 +521,35 @@ "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" } ] + }, + { + "tags": [], + "id": "def-server.APMRouteHandlerResources.apmRuleRegistry", + "type": "Object", + "label": "apmRuleRegistry", + "description": [], + "source": { + "path": "x-pack/plugins/apm/server/routes/typings.ts", + "lineNumber": 65 + }, + "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": 42 + "lineNumber": 45 }, "initialIsOpen": false } @@ -600,7 +631,7 @@ "description": [], "source": { "path": "x-pack/plugins/apm/server/routes/typings.ts", - "lineNumber": 23 + "lineNumber": 26 }, "signature": [ "{ response: any; duration: number; requestType: string; requestParams: Record; esError: Error; }[]" diff --git a/api_docs/apm.mdx b/api_docs/apm.mdx index d8811797b082b..d037dc99e1a54 100644 --- a/api_docs/apm.mdx +++ b/api_docs/apm.mdx @@ -13,6 +13,9 @@ import apmObj from './apm.json'; ## Client +### Setup + + ### Start diff --git a/api_docs/canvas.json b/api_docs/canvas.json index e4b56ae0d6aa1..d6aa1083806b6 100644 --- a/api_docs/canvas.json +++ b/api_docs/canvas.json @@ -60,7 +60,7 @@ ], "source": { "path": "x-pack/plugins/canvas/public/plugin.tsx", - "lineNumber": 65 + "lineNumber": 68 }, "signature": [ "CanvasApi" @@ -76,7 +76,7 @@ "description": [], "source": { "path": "x-pack/plugins/canvas/public/plugin.tsx", - "lineNumber": 66 + "lineNumber": 69 }, "signature": [ "void" @@ -99,6 +99,32 @@ "interfaces": [], "enums": [], "misc": [], - "objects": [] + "objects": [ + { + "id": "def-common.UI_SETTINGS", + "type": "Object", + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.UI_SETTINGS.ENABLE_LABS_UI", + "type": "string", + "label": "ENABLE_LABS_UI", + "description": [], + "source": { + "path": "x-pack/plugins/canvas/common/index.ts", + "lineNumber": 9 + } + } + ], + "description": [], + "label": "UI_SETTINGS", + "source": { + "path": "x-pack/plugins/canvas/common/index.ts", + "lineNumber": 8 + }, + "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..8794a288461db 100644 --- a/api_docs/cases.json +++ b/api_docs/cases.json @@ -1,12 +1,511 @@ { "id": "cases", "client": { - "classes": [], + "classes": [ + { + "id": "def-public.CasesUiPlugin", + "type": "Class", + "tags": [ + "public" + ], + "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" + }, + "" + ], + "description": [], + "source": { + "path": "x-pack/plugins/cases/public/plugin.ts", + "lineNumber": 29 + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "x-pack/plugins/cases/public/plugin.ts", + "lineNumber": 29 + } + }, + { + "id": "def-public.CasesUiPlugin.setup", + "type": "Function", + "label": "setup", + "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" + ], + "description": [], + "children": [ + { + "id": "def-public.CasesUiPlugin.setup.$1", + "type": "Object", + "label": "core", + "isRequired": true, + "signature": [ + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.CoreSetup", + "text": "CoreSetup" + }, + "" + ], + "description": [], + "source": { + "path": "x-pack/plugins/cases/public/plugin.ts", + "lineNumber": 32 + } + }, + { + "id": "def-public.CasesUiPlugin.setup.$2", + "type": "Object", + "label": "plugins", + "isRequired": true, + "signature": [ + { + "pluginId": "cases", + "scope": "public", + "docId": "kibCasesPluginApi", + "section": "def-public.SetupPlugins", + "text": "SetupPlugins" + } + ], + "description": [], + "source": { + "path": "x-pack/plugins/cases/public/plugin.ts", + "lineNumber": 32 + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "x-pack/plugins/cases/public/plugin.ts", + "lineNumber": 32 + } + }, + { + "id": "def-public.CasesUiPlugin.start", + "type": "Function", + "label": "start", + "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" + } + ], + "description": [], + "children": [ + { + "id": "def-public.CasesUiPlugin.start.$1", + "type": "Object", + "label": "core", + "isRequired": true, + "signature": [ + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.CoreStart", + "text": "CoreStart" + } + ], + "description": [], + "source": { + "path": "x-pack/plugins/cases/public/plugin.ts", + "lineNumber": 38 + } + }, + { + "id": "def-public.CasesUiPlugin.start.$2", + "type": "Object", + "label": "plugins", + "isRequired": true, + "signature": [ + { + "pluginId": "cases", + "scope": "public", + "docId": "kibCasesPluginApi", + "section": "def-public.StartPlugins", + "text": "StartPlugins" + } + ], + "description": [], + "source": { + "path": "x-pack/plugins/cases/public/plugin.ts", + "lineNumber": 38 + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "x-pack/plugins/cases/public/plugin.ts", + "lineNumber": 38 + } + }, + { + "id": "def-public.CasesUiPlugin.stop", + "type": "Function", + "label": "stop", + "signature": [ + "() => void" + ], + "description": [], + "children": [], + "tags": [], + "returnComment": [], + "source": { + "path": "x-pack/plugins/cases/public/plugin.ts", + "lineNumber": 92 + } + } + ], + "source": { + "path": "x-pack/plugins/cases/public/plugin.ts", + "lineNumber": 26 + }, + "initialIsOpen": false + } + ], "functions": [], - "interfaces": [], + "interfaces": [ + { + "id": "def-public.SetupPlugins", + "type": "Interface", + "label": "SetupPlugins", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-public.SetupPlugins.security", + "type": "Object", + "label": "security", + "description": [], + "source": { + "path": "x-pack/plugins/cases/public/types.ts", + "lineNumber": 23 + }, + "signature": [ + "{ authc: ", + "AuthenticationServiceSetup", + "; sessionTimeout: ", + "ISessionTimeout", + "; license: Readonly<{ isLicenseAvailable: () => boolean; isEnabled: () => boolean; getType: () => \"basic\" | \"standard\" | \"gold\" | \"platinum\" | \"enterprise\" | \"trial\" | undefined; getFeatures: () => ", + "SecurityLicenseFeatures", + "; features$: ", + "Observable", + "<", + "SecurityLicenseFeatures" + ] + }, + { + "tags": [], + "id": "def-public.SetupPlugins.triggersActionsUi", + "type": "Object", + "label": "triggersActionsUi", + "description": [], + "source": { + "path": "x-pack/plugins/cases/public/types.ts", + "lineNumber": 24 + }, + "signature": [ + { + "pluginId": "triggersActionsUi", + "scope": "public", + "docId": "kibTriggersActionsUiPluginApi", + "section": "def-public.TriggersAndActionsUIPublicPluginSetup", + "text": "TriggersAndActionsUIPublicPluginSetup" + } + ] + } + ], + "source": { + "path": "x-pack/plugins/cases/public/types.ts", + "lineNumber": 22 + }, + "initialIsOpen": false + }, + { + "id": "def-public.StartPlugins", + "type": "Interface", + "label": "StartPlugins", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-public.StartPlugins.triggersActionsUi", + "type": "Object", + "label": "triggersActionsUi", + "description": [], + "source": { + "path": "x-pack/plugins/cases/public/types.ts", + "lineNumber": 28 + }, + "signature": [ + { + "pluginId": "triggersActionsUi", + "scope": "public", + "docId": "kibTriggersActionsUiPluginApi", + "section": "def-public.TriggersAndActionsUIPublicPluginStart", + "text": "TriggersAndActionsUIPublicPluginStart" + } + ] + } + ], + "source": { + "path": "x-pack/plugins/cases/public/types.ts", + "lineNumber": 27 + }, + "initialIsOpen": false + } + ], "enums": [], - "misc": [], - "objects": [] + "misc": [ + { + "id": "def-public.StartServices", + "type": "Type", + "label": "StartServices", + "tags": [], + "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" + ], + "source": { + "path": "x-pack/plugins/cases/public/types.ts", + "lineNumber": 37 + }, + "signature": [ + "CoreStart & StartPlugins & { security: SecurityPluginSetup; }" + ], + "initialIsOpen": false + } + ], + "objects": [], + "start": { + "id": "def-public.CasesUiStart", + "type": "Interface", + "label": "CasesUiStart", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-public.CasesUiStart.getAllCases", + "type": "Function", + "label": "getAllCases", + "description": [], + "source": { + "path": "x-pack/plugins/cases/public/types.ts", + "lineNumber": 43 + }, + "signature": [ + "(props: ", + "AllCasesProps", + ") => React.ReactElement<", + "AllCasesProps", + ", string | ((props: any) => React.ReactElement React.Component)> | null) | (new (props: any) => React.Component)>" + ] + }, + { + "tags": [], + "id": "def-public.CasesUiStart.getAllCasesSelectorModal", + "type": "Function", + "label": "getAllCasesSelectorModal", + "description": [], + "source": { + "path": "x-pack/plugins/cases/public/types.ts", + "lineNumber": 44 + }, + "signature": [ + "(props: ", + "AllCasesSelectorModalProps", + ") => React.ReactElement<", + "AllCasesSelectorModalProps", + ", string | ((props: any) => React.ReactElement React.Component)> | null) | (new (props: any) => React.Component)>" + ] + }, + { + "tags": [], + "id": "def-public.CasesUiStart.getCaseView", + "type": "Function", + "label": "getCaseView", + "description": [], + "source": { + "path": "x-pack/plugins/cases/public/types.ts", + "lineNumber": 47 + }, + "signature": [ + "(props: ", + "CaseViewProps", + ") => React.ReactElement<", + "CaseViewProps", + ", string | ((props: any) => React.ReactElement React.Component)> | null) | (new (props: any) => React.Component)>" + ] + }, + { + "tags": [], + "id": "def-public.CasesUiStart.getConfigureCases", + "type": "Function", + "label": "getConfigureCases", + "description": [], + "source": { + "path": "x-pack/plugins/cases/public/types.ts", + "lineNumber": 48 + }, + "signature": [ + "(props: ", + "ConfigureCasesProps", + ") => React.ReactElement<", + "ConfigureCasesProps", + ", string | ((props: any) => React.ReactElement React.Component)> | null) | (new (props: any) => React.Component)>" + ] + }, + { + "tags": [], + "id": "def-public.CasesUiStart.getCreateCase", + "type": "Function", + "label": "getCreateCase", + "description": [], + "source": { + "path": "x-pack/plugins/cases/public/types.ts", + "lineNumber": 49 + }, + "signature": [ + "(props: ", + "CreateCaseProps", + ") => React.ReactElement<", + "CreateCaseProps", + ", string | ((props: any) => React.ReactElement React.Component)> | null) | (new (props: any) => React.Component)>" + ] + }, + { + "tags": [], + "id": "def-public.CasesUiStart.getRecentCases", + "type": "Function", + "label": "getRecentCases", + "description": [], + "source": { + "path": "x-pack/plugins/cases/public/types.ts", + "lineNumber": 50 + }, + "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": 42 + }, + "lifecycle": "start", + "initialIsOpen": true + } }, "server": { "classes": [], @@ -27,7 +526,7 @@ "description": [], "source": { "path": "x-pack/plugins/cases/server/types.ts", - "lineNumber": 14 + "lineNumber": 13 }, "signature": [ "() => ", @@ -37,7 +536,7 @@ ], "source": { "path": "x-pack/plugins/cases/server/types.ts", - "lineNumber": 13 + "lineNumber": 12 }, "initialIsOpen": false } @@ -48,10 +547,6527 @@ }, "common": { "classes": [], - "functions": [], - "interfaces": [], - "enums": [], - "misc": [], - "objects": [] + "functions": [ + { + "id": "def-common.createPlainError", + "type": "Function", + "children": [ + { + "id": "def-common.createPlainError.$1", + "type": "string", + "label": "message", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "x-pack/plugins/cases/common/api/runtime_types.ts", + "lineNumber": 49 + } + } + ], + "signature": [ + "(message: string) => Error" + ], + "description": [], + "label": "createPlainError", + "source": { + "path": "x-pack/plugins/cases/common/api/runtime_types.ts", + "lineNumber": 49 + }, + "tags": [], + "returnComment": [], + "initialIsOpen": false + }, + { + "id": "def-common.decodeOrThrow", + "type": "Function", + "children": [ + { + "id": "def-common.decodeOrThrow.$1", + "type": "Object", + "label": "runtimeType", + "isRequired": true, + "signature": [ + "Type", + "" + ], + "description": [], + "source": { + "path": "x-pack/plugins/cases/common/api/runtime_types.ts", + "lineNumber": 56 + } + }, + { + "id": "def-common.decodeOrThrow.$2", + "type": "Function", + "label": "createError", + "isRequired": true, + "signature": [ + "ErrorFactory" + ], + "description": [], + "source": { + "path": "x-pack/plugins/cases/common/api/runtime_types.ts", + "lineNumber": 57 + } + } + ], + "signature": [ + "(runtimeType: ", + "Type", + ", createError?: ErrorFactory) => (inputValue: I) => A" + ], + "description": [], + "label": "decodeOrThrow", + "source": { + "path": "x-pack/plugins/cases/common/api/runtime_types.ts", + "lineNumber": 55 + }, + "tags": [], + "returnComment": [], + "initialIsOpen": false + }, + { + "id": "def-common.excess", + "type": "Function", + "label": "excess", + "signature": [ + "(codec: C) => C" + ], + "description": [], + "children": [ + { + "id": "def-common.excess.$1", + "type": "Uncategorized", + "label": "codec", + "isRequired": true, + "signature": [ + "C" + ], + "description": [], + "source": { + "path": "x-pack/plugins/cases/common/api/runtime_types.ts", + "lineNumber": 71 + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "x-pack/plugins/cases/common/api/runtime_types.ts", + "lineNumber": 71 + }, + "initialIsOpen": false + }, + { + "id": "def-common.formatErrors", + "type": "Function", + "children": [ + { + "id": "def-common.formatErrors.$1", + "type": "Object", + "label": "errors", + "isRequired": true, + "signature": [ + "Errors" + ], + "description": [], + "source": { + "path": "x-pack/plugins/cases/common/api/runtime_types.ts", + "lineNumber": 20 + } + } + ], + "signature": [ + "(errors: ", + "Errors", + ") => string[]" + ], + "description": [], + "label": "formatErrors", + "source": { + "path": "x-pack/plugins/cases/common/api/runtime_types.ts", + "lineNumber": 20 + }, + "tags": [ + "deprecated" + ], + "returnComment": [], + "initialIsOpen": false + }, + { + "id": "def-common.getCaseCommentDetailsUrl", + "type": "Function", + "children": [ + { + "id": "def-common.getCaseCommentDetailsUrl.$1", + "type": "string", + "label": "caseId", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "x-pack/plugins/cases/common/api/helpers.ts", + "lineNumber": 35 + } + }, + { + "id": "def-common.getCaseCommentDetailsUrl.$2", + "type": "string", + "label": "commentId", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "x-pack/plugins/cases/common/api/helpers.ts", + "lineNumber": 35 + } + } + ], + "signature": [ + "(caseId: string, commentId: string) => string" + ], + "description": [], + "label": "getCaseCommentDetailsUrl", + "source": { + "path": "x-pack/plugins/cases/common/api/helpers.ts", + "lineNumber": 35 + }, + "tags": [], + "returnComment": [], + "initialIsOpen": false + }, + { + "id": "def-common.getCaseCommentsUrl", + "type": "Function", + "children": [ + { + "id": "def-common.getCaseCommentsUrl.$1", + "type": "string", + "label": "id", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "x-pack/plugins/cases/common/api/helpers.ts", + "lineNumber": 31 + } + } + ], + "signature": [ + "(id: string) => string" + ], + "description": [], + "label": "getCaseCommentsUrl", + "source": { + "path": "x-pack/plugins/cases/common/api/helpers.ts", + "lineNumber": 31 + }, + "tags": [], + "returnComment": [], + "initialIsOpen": false + }, + { + "id": "def-common.getCaseDetailsUrl", + "type": "Function", + "children": [ + { + "id": "def-common.getCaseDetailsUrl.$1", + "type": "string", + "label": "id", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "x-pack/plugins/cases/common/api/helpers.ts", + "lineNumber": 19 + } + } + ], + "signature": [ + "(id: string) => string" + ], + "description": [], + "label": "getCaseDetailsUrl", + "source": { + "path": "x-pack/plugins/cases/common/api/helpers.ts", + "lineNumber": 19 + }, + "tags": [], + "returnComment": [], + "initialIsOpen": false + }, + { + "id": "def-common.getCasePushUrl", + "type": "Function", + "children": [ + { + "id": "def-common.getCasePushUrl.$1", + "type": "string", + "label": "caseId", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "x-pack/plugins/cases/common/api/helpers.ts", + "lineNumber": 47 + } + }, + { + "id": "def-common.getCasePushUrl.$2", + "type": "string", + "label": "connectorId", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "x-pack/plugins/cases/common/api/helpers.ts", + "lineNumber": 47 + } + } + ], + "signature": [ + "(caseId: string, connectorId: string) => string" + ], + "description": [], + "label": "getCasePushUrl", + "source": { + "path": "x-pack/plugins/cases/common/api/helpers.ts", + "lineNumber": 47 + }, + "tags": [], + "returnComment": [], + "initialIsOpen": false + }, + { + "id": "def-common.getCaseUserActionUrl", + "type": "Function", + "children": [ + { + "id": "def-common.getCaseUserActionUrl.$1", + "type": "string", + "label": "id", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "x-pack/plugins/cases/common/api/helpers.ts", + "lineNumber": 39 + } + } + ], + "signature": [ + "(id: string) => string" + ], + "description": [], + "label": "getCaseUserActionUrl", + "source": { + "path": "x-pack/plugins/cases/common/api/helpers.ts", + "lineNumber": 39 + }, + "tags": [], + "returnComment": [], + "initialIsOpen": false + }, + { + "id": "def-common.getSubCaseDetailsUrl", + "type": "Function", + "children": [ + { + "id": "def-common.getSubCaseDetailsUrl.$1", + "type": "string", + "label": "caseID", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "x-pack/plugins/cases/common/api/helpers.ts", + "lineNumber": 27 + } + }, + { + "id": "def-common.getSubCaseDetailsUrl.$2", + "type": "string", + "label": "subCaseId", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "x-pack/plugins/cases/common/api/helpers.ts", + "lineNumber": 27 + } + } + ], + "signature": [ + "(caseID: string, subCaseId: string) => string" + ], + "description": [], + "label": "getSubCaseDetailsUrl", + "source": { + "path": "x-pack/plugins/cases/common/api/helpers.ts", + "lineNumber": 27 + }, + "tags": [], + "returnComment": [], + "initialIsOpen": false + }, + { + "id": "def-common.getSubCasesUrl", + "type": "Function", + "children": [ + { + "id": "def-common.getSubCasesUrl.$1", + "type": "string", + "label": "caseID", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "x-pack/plugins/cases/common/api/helpers.ts", + "lineNumber": 23 + } + } + ], + "signature": [ + "(caseID: string) => string" + ], + "description": [], + "label": "getSubCasesUrl", + "source": { + "path": "x-pack/plugins/cases/common/api/helpers.ts", + "lineNumber": 23 + }, + "tags": [], + "returnComment": [], + "initialIsOpen": false + }, + { + "id": "def-common.getSubCaseUserActionUrl", + "type": "Function", + "children": [ + { + "id": "def-common.getSubCaseUserActionUrl.$1", + "type": "string", + "label": "caseID", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "x-pack/plugins/cases/common/api/helpers.ts", + "lineNumber": 43 + } + }, + { + "id": "def-common.getSubCaseUserActionUrl.$2", + "type": "string", + "label": "subCaseId", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "x-pack/plugins/cases/common/api/helpers.ts", + "lineNumber": 43 + } + } + ], + "signature": [ + "(caseID: string, subCaseId: string) => string" + ], + "description": [], + "label": "getSubCaseUserActionUrl", + "source": { + "path": "x-pack/plugins/cases/common/api/helpers.ts", + "lineNumber": 43 + }, + "tags": [], + "returnComment": [], + "initialIsOpen": false + }, + { + "id": "def-common.throwErrors", + "type": "Function", + "children": [ + { + "id": "def-common.throwErrors.$1", + "type": "Function", + "label": "createError", + "isRequired": true, + "signature": [ + "ErrorFactory" + ], + "description": [], + "source": { + "path": "x-pack/plugins/cases/common/api/runtime_types.ts", + "lineNumber": 51 + } + } + ], + "signature": [ + "(createError: ErrorFactory) => (errors: ", + "Errors", + ") => never" + ], + "description": [], + "label": "throwErrors", + "source": { + "path": "x-pack/plugins/cases/common/api/runtime_types.ts", + "lineNumber": 51 + }, + "tags": [], + "returnComment": [], + "initialIsOpen": false + } + ], + "interfaces": [ + { + "id": "def-common.ActionLicense", + "type": "Interface", + "label": "ActionLicense", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.ActionLicense.id", + "type": "string", + "label": "id", + "description": [], + "source": { + "path": "x-pack/plugins/cases/common/ui/types.ts", + "lineNumber": 145 + } + }, + { + "tags": [], + "id": "def-common.ActionLicense.name", + "type": "string", + "label": "name", + "description": [], + "source": { + "path": "x-pack/plugins/cases/common/ui/types.ts", + "lineNumber": 146 + } + }, + { + "tags": [], + "id": "def-common.ActionLicense.enabled", + "type": "boolean", + "label": "enabled", + "description": [], + "source": { + "path": "x-pack/plugins/cases/common/ui/types.ts", + "lineNumber": 147 + } + }, + { + "tags": [], + "id": "def-common.ActionLicense.enabledInConfig", + "type": "boolean", + "label": "enabledInConfig", + "description": [], + "source": { + "path": "x-pack/plugins/cases/common/ui/types.ts", + "lineNumber": 148 + } + }, + { + "tags": [], + "id": "def-common.ActionLicense.enabledInLicense", + "type": "boolean", + "label": "enabledInLicense", + "description": [], + "source": { + "path": "x-pack/plugins/cases/common/ui/types.ts", + "lineNumber": 149 + } + } + ], + "source": { + "path": "x-pack/plugins/cases/common/ui/types.ts", + "lineNumber": 144 + }, + "initialIsOpen": false + }, + { + "id": "def-common.AllCases", + "type": "Interface", + "label": "AllCases", + "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" + } + ], + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.AllCases.cases", + "type": "Array", + "label": "cases", + "description": [], + "source": { + "path": "x-pack/plugins/cases/common/ui/types.ts", + "lineNumber": 113 + }, + "signature": [ + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.Case", + "text": "Case" + }, + "[]" + ] + }, + { + "tags": [], + "id": "def-common.AllCases.page", + "type": "number", + "label": "page", + "description": [], + "source": { + "path": "x-pack/plugins/cases/common/ui/types.ts", + "lineNumber": 114 + } + }, + { + "tags": [], + "id": "def-common.AllCases.perPage", + "type": "number", + "label": "perPage", + "description": [], + "source": { + "path": "x-pack/plugins/cases/common/ui/types.ts", + "lineNumber": 115 + } + }, + { + "tags": [], + "id": "def-common.AllCases.total", + "type": "number", + "label": "total", + "description": [], + "source": { + "path": "x-pack/plugins/cases/common/ui/types.ts", + "lineNumber": 116 + } + } + ], + "source": { + "path": "x-pack/plugins/cases/common/ui/types.ts", + "lineNumber": 112 + }, + "initialIsOpen": false + }, + { + "id": "def-common.ApiProps", + "type": "Interface", + "label": "ApiProps", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.ApiProps.signal", + "type": "Object", + "label": "signal", + "description": [], + "source": { + "path": "x-pack/plugins/cases/common/ui/types.ts", + "lineNumber": 136 + }, + "signature": [ + "AbortSignal" + ] + } + ], + "source": { + "path": "x-pack/plugins/cases/common/ui/types.ts", + "lineNumber": 135 + }, + "initialIsOpen": false + }, + { + "id": "def-common.BulkUpdateStatus", + "type": "Interface", + "label": "BulkUpdateStatus", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.BulkUpdateStatus.status", + "type": "string", + "label": "status", + "description": [], + "source": { + "path": "x-pack/plugins/cases/common/ui/types.ts", + "lineNumber": 140 + } + }, + { + "tags": [], + "id": "def-common.BulkUpdateStatus.id", + "type": "string", + "label": "id", + "description": [], + "source": { + "path": "x-pack/plugins/cases/common/ui/types.ts", + "lineNumber": 141 + } + }, + { + "tags": [], + "id": "def-common.BulkUpdateStatus.version", + "type": "string", + "label": "version", + "description": [], + "source": { + "path": "x-pack/plugins/cases/common/ui/types.ts", + "lineNumber": 142 + } + } + ], + "source": { + "path": "x-pack/plugins/cases/common/ui/types.ts", + "lineNumber": 139 + }, + "initialIsOpen": false + }, + { + "id": "def-common.Case", + "type": "Interface", + "label": "Case", + "signature": [ + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.Case", + "text": "Case" + }, + " extends BasicCase" + ], + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.Case.connector", + "type": "CompoundType", + "label": "connector", + "description": [], + "source": { + "path": "x-pack/plugins/cases/common/ui/types.ts", + "lineNumber": 81 + }, + "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" + } + ] + }, + { + "tags": [], + "id": "def-common.Case.description", + "type": "string", + "label": "description", + "description": [], + "source": { + "path": "x-pack/plugins/cases/common/ui/types.ts", + "lineNumber": 82 + } + }, + { + "tags": [], + "id": "def-common.Case.externalService", + "type": "CompoundType", + "label": "externalService", + "description": [], + "source": { + "path": "x-pack/plugins/cases/common/ui/types.ts", + "lineNumber": 83 + }, + "signature": [ + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.CaseExternalService", + "text": "CaseExternalService" + }, + " | null" + ] + }, + { + "tags": [], + "id": "def-common.Case.subCases", + "type": "CompoundType", + "label": "subCases", + "description": [], + "source": { + "path": "x-pack/plugins/cases/common/ui/types.ts", + "lineNumber": 84 + }, + "signature": [ + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.SubCase", + "text": "SubCase" + }, + "[] | null | undefined" + ] + }, + { + "tags": [], + "id": "def-common.Case.subCaseIds", + "type": "Array", + "label": "subCaseIds", + "description": [], + "source": { + "path": "x-pack/plugins/cases/common/ui/types.ts", + "lineNumber": 85 + }, + "signature": [ + "string[]" + ] + }, + { + "tags": [], + "id": "def-common.Case.settings", + "type": "Object", + "label": "settings", + "description": [], + "source": { + "path": "x-pack/plugins/cases/common/ui/types.ts", + "lineNumber": 86 + }, + "signature": [ + "{ syncAlerts: boolean; }" + ] + }, + { + "tags": [], + "id": "def-common.Case.tags", + "type": "Array", + "label": "tags", + "description": [], + "source": { + "path": "x-pack/plugins/cases/common/ui/types.ts", + "lineNumber": 87 + }, + "signature": [ + "string[]" + ] + }, + { + "tags": [], + "id": "def-common.Case.type", + "type": "Enum", + "label": "type", + "description": [], + "source": { + "path": "x-pack/plugins/cases/common/ui/types.ts", + "lineNumber": 88 + }, + "signature": [ + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.CaseType", + "text": "CaseType" + } + ] + } + ], + "source": { + "path": "x-pack/plugins/cases/common/ui/types.ts", + "lineNumber": 80 + }, + "initialIsOpen": false + }, + { + "id": "def-common.CaseExternalService", + "type": "Interface", + "label": "CaseExternalService", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.CaseExternalService.pushedAt", + "type": "string", + "label": "pushedAt", + "description": [], + "source": { + "path": "x-pack/plugins/cases/common/ui/types.ts", + "lineNumber": 50 + } + }, + { + "tags": [], + "id": "def-common.CaseExternalService.pushedBy", + "type": "Object", + "label": "pushedBy", + "description": [], + "source": { + "path": "x-pack/plugins/cases/common/ui/types.ts", + "lineNumber": 51 + }, + "signature": [ + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.ElasticUser", + "text": "ElasticUser" + } + ] + }, + { + "tags": [], + "id": "def-common.CaseExternalService.connectorId", + "type": "string", + "label": "connectorId", + "description": [], + "source": { + "path": "x-pack/plugins/cases/common/ui/types.ts", + "lineNumber": 52 + } + }, + { + "tags": [], + "id": "def-common.CaseExternalService.connectorName", + "type": "string", + "label": "connectorName", + "description": [], + "source": { + "path": "x-pack/plugins/cases/common/ui/types.ts", + "lineNumber": 53 + } + }, + { + "tags": [], + "id": "def-common.CaseExternalService.externalId", + "type": "string", + "label": "externalId", + "description": [], + "source": { + "path": "x-pack/plugins/cases/common/ui/types.ts", + "lineNumber": 54 + } + }, + { + "tags": [], + "id": "def-common.CaseExternalService.externalTitle", + "type": "string", + "label": "externalTitle", + "description": [], + "source": { + "path": "x-pack/plugins/cases/common/ui/types.ts", + "lineNumber": 55 + } + }, + { + "tags": [], + "id": "def-common.CaseExternalService.externalUrl", + "type": "string", + "label": "externalUrl", + "description": [], + "source": { + "path": "x-pack/plugins/cases/common/ui/types.ts", + "lineNumber": 56 + } + } + ], + "source": { + "path": "x-pack/plugins/cases/common/ui/types.ts", + "lineNumber": 49 + }, + "initialIsOpen": false + }, + { + "id": "def-common.CasesStatus", + "type": "Interface", + "label": "CasesStatus", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.CasesStatus.countClosedCases", + "type": "CompoundType", + "label": "countClosedCases", + "description": [], + "source": { + "path": "x-pack/plugins/cases/common/ui/types.ts", + "lineNumber": 107 + }, + "signature": [ + "number | null" + ] + }, + { + "tags": [], + "id": "def-common.CasesStatus.countOpenCases", + "type": "CompoundType", + "label": "countOpenCases", + "description": [], + "source": { + "path": "x-pack/plugins/cases/common/ui/types.ts", + "lineNumber": 108 + }, + "signature": [ + "number | null" + ] + }, + { + "tags": [], + "id": "def-common.CasesStatus.countInProgressCases", + "type": "CompoundType", + "label": "countInProgressCases", + "description": [], + "source": { + "path": "x-pack/plugins/cases/common/ui/types.ts", + "lineNumber": 109 + }, + "signature": [ + "number | null" + ] + } + ], + "source": { + "path": "x-pack/plugins/cases/common/ui/types.ts", + "lineNumber": 106 + }, + "initialIsOpen": false + }, + { + "id": "def-common.CaseUserActions", + "type": "Interface", + "label": "CaseUserActions", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.CaseUserActions.actionId", + "type": "string", + "label": "actionId", + "description": [], + "source": { + "path": "x-pack/plugins/cases/common/ui/types.ts", + "lineNumber": 38 + } + }, + { + "tags": [], + "id": "def-common.CaseUserActions.actionField", + "type": "Array", + "label": "actionField", + "description": [], + "source": { + "path": "x-pack/plugins/cases/common/ui/types.ts", + "lineNumber": 39 + }, + "signature": [ + "(\"status\" | \"description\" | \"title\" | \"comment\" | \"tags\" | \"settings\" | \"connector\" | \"pushed\" | \"sub_case\")[]" + ] + }, + { + "tags": [], + "id": "def-common.CaseUserActions.action", + "type": "CompoundType", + "label": "action", + "description": [], + "source": { + "path": "x-pack/plugins/cases/common/ui/types.ts", + "lineNumber": 40 + }, + "signature": [ + "\"add\" | \"delete\" | \"create\" | \"update\" | \"push-to-service\"" + ] + }, + { + "tags": [], + "id": "def-common.CaseUserActions.actionAt", + "type": "string", + "label": "actionAt", + "description": [], + "source": { + "path": "x-pack/plugins/cases/common/ui/types.ts", + "lineNumber": 41 + } + }, + { + "tags": [], + "id": "def-common.CaseUserActions.actionBy", + "type": "Object", + "label": "actionBy", + "description": [], + "source": { + "path": "x-pack/plugins/cases/common/ui/types.ts", + "lineNumber": 42 + }, + "signature": [ + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.ElasticUser", + "text": "ElasticUser" + } + ] + }, + { + "tags": [], + "id": "def-common.CaseUserActions.caseId", + "type": "string", + "label": "caseId", + "description": [], + "source": { + "path": "x-pack/plugins/cases/common/ui/types.ts", + "lineNumber": 43 + } + }, + { + "tags": [], + "id": "def-common.CaseUserActions.commentId", + "type": "CompoundType", + "label": "commentId", + "description": [], + "source": { + "path": "x-pack/plugins/cases/common/ui/types.ts", + "lineNumber": 44 + }, + "signature": [ + "string | null" + ] + }, + { + "tags": [], + "id": "def-common.CaseUserActions.newValue", + "type": "CompoundType", + "label": "newValue", + "description": [], + "source": { + "path": "x-pack/plugins/cases/common/ui/types.ts", + "lineNumber": 45 + }, + "signature": [ + "string | null" + ] + }, + { + "tags": [], + "id": "def-common.CaseUserActions.oldValue", + "type": "CompoundType", + "label": "oldValue", + "description": [], + "source": { + "path": "x-pack/plugins/cases/common/ui/types.ts", + "lineNumber": 46 + }, + "signature": [ + "string | null" + ] + } + ], + "source": { + "path": "x-pack/plugins/cases/common/ui/types.ts", + "lineNumber": 37 + }, + "initialIsOpen": false + }, + { + "id": "def-common.DeleteCase", + "type": "Interface", + "label": "DeleteCase", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.DeleteCase.id", + "type": "string", + "label": "id", + "description": [], + "source": { + "path": "x-pack/plugins/cases/common/ui/types.ts", + "lineNumber": 153 + } + }, + { + "tags": [], + "id": "def-common.DeleteCase.type", + "type": "CompoundType", + "label": "type", + "description": [], + "source": { + "path": "x-pack/plugins/cases/common/ui/types.ts", + "lineNumber": 154 + }, + "signature": [ + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.CaseType", + "text": "CaseType" + }, + " | null" + ] + }, + { + "tags": [], + "id": "def-common.DeleteCase.title", + "type": "string", + "label": "title", + "description": [], + "source": { + "path": "x-pack/plugins/cases/common/ui/types.ts", + "lineNumber": 155 + }, + "signature": [ + "string | undefined" + ] + } + ], + "source": { + "path": "x-pack/plugins/cases/common/ui/types.ts", + "lineNumber": 152 + }, + "initialIsOpen": false + }, + { + "id": "def-common.Ecs", + "type": "Interface", + "label": "Ecs", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.Ecs._id", + "type": "string", + "label": "_id", + "description": [], + "source": { + "path": "x-pack/plugins/cases/common/ui/types.ts", + "lineNumber": 226 + } + }, + { + "tags": [], + "id": "def-common.Ecs._index", + "type": "string", + "label": "_index", + "description": [], + "source": { + "path": "x-pack/plugins/cases/common/ui/types.ts", + "lineNumber": 227 + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [], + "id": "def-common.Ecs.signal", + "type": "Object", + "label": "signal", + "description": [], + "source": { + "path": "x-pack/plugins/cases/common/ui/types.ts", + "lineNumber": 228 + }, + "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": 225 + }, + "initialIsOpen": false + }, + { + "id": "def-common.ElasticUser", + "type": "Interface", + "label": "ElasticUser", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.ElasticUser.email", + "type": "CompoundType", + "label": "email", + "description": [], + "source": { + "path": "x-pack/plugins/cases/common/ui/types.ts", + "lineNumber": 125 + }, + "signature": [ + "string | null | undefined" + ] + }, + { + "tags": [], + "id": "def-common.ElasticUser.fullName", + "type": "CompoundType", + "label": "fullName", + "description": [], + "source": { + "path": "x-pack/plugins/cases/common/ui/types.ts", + "lineNumber": 126 + }, + "signature": [ + "string | null | undefined" + ] + }, + { + "tags": [], + "id": "def-common.ElasticUser.username", + "type": "CompoundType", + "label": "username", + "description": [], + "source": { + "path": "x-pack/plugins/cases/common/ui/types.ts", + "lineNumber": 127 + }, + "signature": [ + "string | null | undefined" + ] + } + ], + "source": { + "path": "x-pack/plugins/cases/common/ui/types.ts", + "lineNumber": 124 + }, + "initialIsOpen": false + }, + { + "id": "def-common.ESCaseConnector", + "type": "Interface", + "label": "ESCaseConnector", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.ESCaseConnector.id", + "type": "string", + "label": "id", + "description": [], + "source": { + "path": "x-pack/plugins/cases/common/api/connectors/index.ts", + "lineNumber": 101 + } + }, + { + "tags": [], + "id": "def-common.ESCaseConnector.name", + "type": "string", + "label": "name", + "description": [], + "source": { + "path": "x-pack/plugins/cases/common/api/connectors/index.ts", + "lineNumber": 102 + } + }, + { + "tags": [], + "id": "def-common.ESCaseConnector.type", + "type": "Enum", + "label": "type", + "description": [], + "source": { + "path": "x-pack/plugins/cases/common/api/connectors/index.ts", + "lineNumber": 103 + }, + "signature": [ + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.ConnectorTypes", + "text": "ConnectorTypes" + } + ] + }, + { + "tags": [], + "id": "def-common.ESCaseConnector.fields", + "type": "CompoundType", + "label": "fields", + "description": [], + "source": { + "path": "x-pack/plugins/cases/common/api/connectors/index.ts", + "lineNumber": 104 + }, + "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": 100 + }, + "initialIsOpen": false + }, + { + "id": "def-common.FetchCasesProps", + "type": "Interface", + "label": "FetchCasesProps", + "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" + } + ], + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.FetchCasesProps.queryParams", + "type": "Object", + "label": "queryParams", + "description": [], + "source": { + "path": "x-pack/plugins/cases/common/ui/types.ts", + "lineNumber": 131 + }, + "signature": [ + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.QueryParams", + "text": "QueryParams" + }, + " | undefined" + ] + }, + { + "tags": [], + "id": "def-common.FetchCasesProps.filterOptions", + "type": "Object", + "label": "filterOptions", + "description": [], + "source": { + "path": "x-pack/plugins/cases/common/ui/types.ts", + "lineNumber": 132 + }, + "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": 130 + }, + "initialIsOpen": false + }, + { + "id": "def-common.FieldMappings", + "type": "Interface", + "label": "FieldMappings", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.FieldMappings.id", + "type": "string", + "label": "id", + "description": [], + "source": { + "path": "x-pack/plugins/cases/common/ui/types.ts", + "lineNumber": 159 + } + }, + { + "tags": [], + "id": "def-common.FieldMappings.title", + "type": "string", + "label": "title", + "description": [], + "source": { + "path": "x-pack/plugins/cases/common/ui/types.ts", + "lineNumber": 160 + }, + "signature": [ + "string | undefined" + ] + } + ], + "source": { + "path": "x-pack/plugins/cases/common/ui/types.ts", + "lineNumber": 158 + }, + "initialIsOpen": false + }, + { + "id": "def-common.FilterOptions", + "type": "Interface", + "label": "FilterOptions", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.FilterOptions.search", + "type": "string", + "label": "search", + "description": [], + "source": { + "path": "x-pack/plugins/cases/common/ui/types.ts", + "lineNumber": 99 + } + }, + { + "tags": [], + "id": "def-common.FilterOptions.status", + "type": "CompoundType", + "label": "status", + "description": [], + "source": { + "path": "x-pack/plugins/cases/common/ui/types.ts", + "lineNumber": 100 + }, + "signature": [ + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.CaseStatusWithAllStatus", + "text": "CaseStatusWithAllStatus" + } + ] + }, + { + "tags": [], + "id": "def-common.FilterOptions.tags", + "type": "Array", + "label": "tags", + "description": [], + "source": { + "path": "x-pack/plugins/cases/common/ui/types.ts", + "lineNumber": 101 + }, + "signature": [ + "string[]" + ] + }, + { + "tags": [], + "id": "def-common.FilterOptions.reporters", + "type": "Array", + "label": "reporters", + "description": [], + "source": { + "path": "x-pack/plugins/cases/common/ui/types.ts", + "lineNumber": 102 + }, + "signature": [ + "{ email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; }[]" + ] + }, + { + "tags": [], + "id": "def-common.FilterOptions.onlyCollectionType", + "type": "CompoundType", + "label": "onlyCollectionType", + "description": [], + "source": { + "path": "x-pack/plugins/cases/common/ui/types.ts", + "lineNumber": 103 + }, + "signature": [ + "boolean | undefined" + ] + } + ], + "source": { + "path": "x-pack/plugins/cases/common/ui/types.ts", + "lineNumber": 98 + }, + "initialIsOpen": false + }, + { + "id": "def-common.QueryParams", + "type": "Interface", + "label": "QueryParams", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.QueryParams.page", + "type": "number", + "label": "page", + "description": [], + "source": { + "path": "x-pack/plugins/cases/common/ui/types.ts", + "lineNumber": 92 + } + }, + { + "tags": [], + "id": "def-common.QueryParams.perPage", + "type": "number", + "label": "perPage", + "description": [], + "source": { + "path": "x-pack/plugins/cases/common/ui/types.ts", + "lineNumber": 93 + } + }, + { + "tags": [], + "id": "def-common.QueryParams.sortField", + "type": "Enum", + "label": "sortField", + "description": [], + "source": { + "path": "x-pack/plugins/cases/common/ui/types.ts", + "lineNumber": 94 + }, + "signature": [ + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.SortFieldCase", + "text": "SortFieldCase" + } + ] + }, + { + "tags": [], + "id": "def-common.QueryParams.sortOrder", + "type": "CompoundType", + "label": "sortOrder", + "description": [], + "source": { + "path": "x-pack/plugins/cases/common/ui/types.ts", + "lineNumber": 95 + }, + "signature": [ + "\"asc\" | \"desc\"" + ] + } + ], + "source": { + "path": "x-pack/plugins/cases/common/ui/types.ts", + "lineNumber": 91 + }, + "initialIsOpen": false + }, + { + "id": "def-common.RuleEcs", + "type": "Interface", + "label": "RuleEcs", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.RuleEcs.id", + "type": "Array", + "label": "id", + "description": [], + "source": { + "path": "x-pack/plugins/cases/common/ui/types.ts", + "lineNumber": 179 + }, + "signature": [ + "string[] | undefined" + ] + }, + { + "tags": [], + "id": "def-common.RuleEcs.rule_id", + "type": "Array", + "label": "rule_id", + "description": [], + "source": { + "path": "x-pack/plugins/cases/common/ui/types.ts", + "lineNumber": 180 + }, + "signature": [ + "string[] | undefined" + ] + }, + { + "tags": [], + "id": "def-common.RuleEcs.name", + "type": "Array", + "label": "name", + "description": [], + "source": { + "path": "x-pack/plugins/cases/common/ui/types.ts", + "lineNumber": 181 + }, + "signature": [ + "string[] | undefined" + ] + }, + { + "tags": [], + "id": "def-common.RuleEcs.false_positives", + "type": "Array", + "label": "false_positives", + "description": [], + "source": { + "path": "x-pack/plugins/cases/common/ui/types.ts", + "lineNumber": 182 + }, + "signature": [ + "string[]" + ] + }, + { + "tags": [], + "id": "def-common.RuleEcs.saved_id", + "type": "Array", + "label": "saved_id", + "description": [], + "source": { + "path": "x-pack/plugins/cases/common/ui/types.ts", + "lineNumber": 183 + }, + "signature": [ + "string[] | undefined" + ] + }, + { + "tags": [], + "id": "def-common.RuleEcs.timeline_id", + "type": "Array", + "label": "timeline_id", + "description": [], + "source": { + "path": "x-pack/plugins/cases/common/ui/types.ts", + "lineNumber": 184 + }, + "signature": [ + "string[] | undefined" + ] + }, + { + "tags": [], + "id": "def-common.RuleEcs.timeline_title", + "type": "Array", + "label": "timeline_title", + "description": [], + "source": { + "path": "x-pack/plugins/cases/common/ui/types.ts", + "lineNumber": 185 + }, + "signature": [ + "string[] | undefined" + ] + }, + { + "tags": [], + "id": "def-common.RuleEcs.max_signals", + "type": "Array", + "label": "max_signals", + "description": [], + "source": { + "path": "x-pack/plugins/cases/common/ui/types.ts", + "lineNumber": 186 + }, + "signature": [ + "number[] | undefined" + ] + }, + { + "tags": [], + "id": "def-common.RuleEcs.risk_score", + "type": "Array", + "label": "risk_score", + "description": [], + "source": { + "path": "x-pack/plugins/cases/common/ui/types.ts", + "lineNumber": 187 + }, + "signature": [ + "string[] | undefined" + ] + }, + { + "tags": [], + "id": "def-common.RuleEcs.output_index", + "type": "Array", + "label": "output_index", + "description": [], + "source": { + "path": "x-pack/plugins/cases/common/ui/types.ts", + "lineNumber": 188 + }, + "signature": [ + "string[] | undefined" + ] + }, + { + "tags": [], + "id": "def-common.RuleEcs.description", + "type": "Array", + "label": "description", + "description": [], + "source": { + "path": "x-pack/plugins/cases/common/ui/types.ts", + "lineNumber": 189 + }, + "signature": [ + "string[] | undefined" + ] + }, + { + "tags": [], + "id": "def-common.RuleEcs.from", + "type": "Array", + "label": "from", + "description": [], + "source": { + "path": "x-pack/plugins/cases/common/ui/types.ts", + "lineNumber": 190 + }, + "signature": [ + "string[] | undefined" + ] + }, + { + "tags": [], + "id": "def-common.RuleEcs.immutable", + "type": "Array", + "label": "immutable", + "description": [], + "source": { + "path": "x-pack/plugins/cases/common/ui/types.ts", + "lineNumber": 191 + }, + "signature": [ + "boolean[] | undefined" + ] + }, + { + "tags": [], + "id": "def-common.RuleEcs.index", + "type": "Array", + "label": "index", + "description": [], + "source": { + "path": "x-pack/plugins/cases/common/ui/types.ts", + "lineNumber": 192 + }, + "signature": [ + "string[] | undefined" + ] + }, + { + "tags": [], + "id": "def-common.RuleEcs.interval", + "type": "Array", + "label": "interval", + "description": [], + "source": { + "path": "x-pack/plugins/cases/common/ui/types.ts", + "lineNumber": 193 + }, + "signature": [ + "string[] | undefined" + ] + }, + { + "tags": [], + "id": "def-common.RuleEcs.language", + "type": "Array", + "label": "language", + "description": [], + "source": { + "path": "x-pack/plugins/cases/common/ui/types.ts", + "lineNumber": 194 + }, + "signature": [ + "string[] | undefined" + ] + }, + { + "tags": [], + "id": "def-common.RuleEcs.query", + "type": "Array", + "label": "query", + "description": [], + "source": { + "path": "x-pack/plugins/cases/common/ui/types.ts", + "lineNumber": 195 + }, + "signature": [ + "string[] | undefined" + ] + }, + { + "tags": [], + "id": "def-common.RuleEcs.references", + "type": "Array", + "label": "references", + "description": [], + "source": { + "path": "x-pack/plugins/cases/common/ui/types.ts", + "lineNumber": 196 + }, + "signature": [ + "string[] | undefined" + ] + }, + { + "tags": [], + "id": "def-common.RuleEcs.severity", + "type": "Array", + "label": "severity", + "description": [], + "source": { + "path": "x-pack/plugins/cases/common/ui/types.ts", + "lineNumber": 197 + }, + "signature": [ + "string[] | undefined" + ] + }, + { + "tags": [], + "id": "def-common.RuleEcs.tags", + "type": "Array", + "label": "tags", + "description": [], + "source": { + "path": "x-pack/plugins/cases/common/ui/types.ts", + "lineNumber": 198 + }, + "signature": [ + "string[] | undefined" + ] + }, + { + "tags": [], + "id": "def-common.RuleEcs.threat", + "type": "Unknown", + "label": "threat", + "description": [], + "source": { + "path": "x-pack/plugins/cases/common/ui/types.ts", + "lineNumber": 199 + }, + "signature": [ + "unknown" + ] + }, + { + "tags": [], + "id": "def-common.RuleEcs.threshold", + "type": "Unknown", + "label": "threshold", + "description": [], + "source": { + "path": "x-pack/plugins/cases/common/ui/types.ts", + "lineNumber": 200 + }, + "signature": [ + "unknown" + ] + }, + { + "tags": [], + "id": "def-common.RuleEcs.type", + "type": "Array", + "label": "type", + "description": [], + "source": { + "path": "x-pack/plugins/cases/common/ui/types.ts", + "lineNumber": 201 + }, + "signature": [ + "string[] | undefined" + ] + }, + { + "tags": [], + "id": "def-common.RuleEcs.size", + "type": "Array", + "label": "size", + "description": [], + "source": { + "path": "x-pack/plugins/cases/common/ui/types.ts", + "lineNumber": 202 + }, + "signature": [ + "string[] | undefined" + ] + }, + { + "tags": [], + "id": "def-common.RuleEcs.to", + "type": "Array", + "label": "to", + "description": [], + "source": { + "path": "x-pack/plugins/cases/common/ui/types.ts", + "lineNumber": 203 + }, + "signature": [ + "string[] | undefined" + ] + }, + { + "tags": [], + "id": "def-common.RuleEcs.enabled", + "type": "Array", + "label": "enabled", + "description": [], + "source": { + "path": "x-pack/plugins/cases/common/ui/types.ts", + "lineNumber": 204 + }, + "signature": [ + "boolean[] | undefined" + ] + }, + { + "tags": [], + "id": "def-common.RuleEcs.filters", + "type": "Unknown", + "label": "filters", + "description": [], + "source": { + "path": "x-pack/plugins/cases/common/ui/types.ts", + "lineNumber": 205 + }, + "signature": [ + "unknown" + ] + }, + { + "tags": [], + "id": "def-common.RuleEcs.created_at", + "type": "Array", + "label": "created_at", + "description": [], + "source": { + "path": "x-pack/plugins/cases/common/ui/types.ts", + "lineNumber": 206 + }, + "signature": [ + "string[] | undefined" + ] + }, + { + "tags": [], + "id": "def-common.RuleEcs.updated_at", + "type": "Array", + "label": "updated_at", + "description": [], + "source": { + "path": "x-pack/plugins/cases/common/ui/types.ts", + "lineNumber": 207 + }, + "signature": [ + "string[] | undefined" + ] + }, + { + "tags": [], + "id": "def-common.RuleEcs.created_by", + "type": "Array", + "label": "created_by", + "description": [], + "source": { + "path": "x-pack/plugins/cases/common/ui/types.ts", + "lineNumber": 208 + }, + "signature": [ + "string[] | undefined" + ] + }, + { + "tags": [], + "id": "def-common.RuleEcs.updated_by", + "type": "Array", + "label": "updated_by", + "description": [], + "source": { + "path": "x-pack/plugins/cases/common/ui/types.ts", + "lineNumber": 209 + }, + "signature": [ + "string[] | undefined" + ] + }, + { + "tags": [], + "id": "def-common.RuleEcs.version", + "type": "Array", + "label": "version", + "description": [], + "source": { + "path": "x-pack/plugins/cases/common/ui/types.ts", + "lineNumber": 210 + }, + "signature": [ + "string[] | undefined" + ] + }, + { + "tags": [], + "id": "def-common.RuleEcs.note", + "type": "Array", + "label": "note", + "description": [], + "source": { + "path": "x-pack/plugins/cases/common/ui/types.ts", + "lineNumber": 211 + }, + "signature": [ + "string[] | undefined" + ] + }, + { + "tags": [], + "id": "def-common.RuleEcs.building_block_type", + "type": "Array", + "label": "building_block_type", + "description": [], + "source": { + "path": "x-pack/plugins/cases/common/ui/types.ts", + "lineNumber": 212 + }, + "signature": [ + "string[] | undefined" + ] + } + ], + "source": { + "path": "x-pack/plugins/cases/common/ui/types.ts", + "lineNumber": 178 + }, + "initialIsOpen": false + }, + { + "id": "def-common.SignalEcs", + "type": "Interface", + "label": "SignalEcs", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.SignalEcs.rule", + "type": "Object", + "label": "rule", + "description": [], + "source": { + "path": "x-pack/plugins/cases/common/ui/types.ts", + "lineNumber": 216 + }, + "signature": [ + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.RuleEcs", + "text": "RuleEcs" + }, + " | undefined" + ] + }, + { + "tags": [], + "id": "def-common.SignalEcs.original_time", + "type": "Array", + "label": "original_time", + "description": [], + "source": { + "path": "x-pack/plugins/cases/common/ui/types.ts", + "lineNumber": 217 + }, + "signature": [ + "string[] | undefined" + ] + }, + { + "tags": [], + "id": "def-common.SignalEcs.status", + "type": "Array", + "label": "status", + "description": [], + "source": { + "path": "x-pack/plugins/cases/common/ui/types.ts", + "lineNumber": 218 + }, + "signature": [ + "string[] | undefined" + ] + }, + { + "tags": [], + "id": "def-common.SignalEcs.group", + "type": "Object", + "label": "group", + "description": [], + "source": { + "path": "x-pack/plugins/cases/common/ui/types.ts", + "lineNumber": 219 + }, + "signature": [ + "{ id?: string[] | undefined; } | undefined" + ] + }, + { + "tags": [], + "id": "def-common.SignalEcs.threshold_result", + "type": "Unknown", + "label": "threshold_result", + "description": [], + "source": { + "path": "x-pack/plugins/cases/common/ui/types.ts", + "lineNumber": 222 + }, + "signature": [ + "unknown" + ] + } + ], + "source": { + "path": "x-pack/plugins/cases/common/ui/types.ts", + "lineNumber": 215 + }, + "initialIsOpen": false + }, + { + "id": "def-common.SubCase", + "type": "Interface", + "label": "SubCase", + "signature": [ + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.SubCase", + "text": "SubCase" + }, + " extends BasicCase" + ], + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.SubCase.associationType", + "type": "Enum", + "label": "associationType", + "description": [], + "source": { + "path": "x-pack/plugins/cases/common/ui/types.ts", + "lineNumber": 76 + }, + "signature": [ + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.AssociationType", + "text": "AssociationType" + } + ] + }, + { + "tags": [], + "id": "def-common.SubCase.caseParentId", + "type": "string", + "label": "caseParentId", + "description": [], + "source": { + "path": "x-pack/plugins/cases/common/ui/types.ts", + "lineNumber": 77 + } + } + ], + "source": { + "path": "x-pack/plugins/cases/common/ui/types.ts", + "lineNumber": 75 + }, + "initialIsOpen": false + }, + { + "id": "def-common.UpdateByKey", + "type": "Interface", + "label": "UpdateByKey", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.UpdateByKey.updateKey", + "type": "CompoundType", + "label": "updateKey", + "description": [], + "source": { + "path": "x-pack/plugins/cases/common/ui/types.ts", + "lineNumber": 169 + }, + "signature": [ + "\"status\" | \"description\" | \"title\" | \"tags\" | \"settings\" | \"connector\"" + ] + }, + { + "tags": [], + "id": "def-common.UpdateByKey.updateValue", + "type": "CompoundType", + "label": "updateValue", + "description": [], + "source": { + "path": "x-pack/plugins/cases/common/ui/types.ts", + "lineNumber": 170 + }, + "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" + } + ] + }, + { + "tags": [], + "id": "def-common.UpdateByKey.fetchCaseUserActions", + "type": "Function", + "label": "fetchCaseUserActions", + "description": [], + "source": { + "path": "x-pack/plugins/cases/common/ui/types.ts", + "lineNumber": 171 + }, + "signature": [ + "((caseId: string, caseConnectorId: string, subCaseId?: string | undefined) => void) | undefined" + ] + }, + { + "tags": [], + "id": "def-common.UpdateByKey.updateCase", + "type": "Function", + "label": "updateCase", + "description": [], + "source": { + "path": "x-pack/plugins/cases/common/ui/types.ts", + "lineNumber": 172 + }, + "signature": [ + "((newCase: ", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.Case", + "text": "Case" + }, + ") => void) | undefined" + ] + }, + { + "tags": [], + "id": "def-common.UpdateByKey.caseData", + "type": "Object", + "label": "caseData", + "description": [], + "source": { + "path": "x-pack/plugins/cases/common/ui/types.ts", + "lineNumber": 173 + }, + "signature": [ + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.Case", + "text": "Case" + } + ] + }, + { + "tags": [], + "id": "def-common.UpdateByKey.onSuccess", + "type": "Function", + "label": "onSuccess", + "description": [], + "source": { + "path": "x-pack/plugins/cases/common/ui/types.ts", + "lineNumber": 174 + }, + "signature": [ + "(() => void) | undefined" + ] + }, + { + "tags": [], + "id": "def-common.UpdateByKey.onError", + "type": "Function", + "label": "onError", + "description": [], + "source": { + "path": "x-pack/plugins/cases/common/ui/types.ts", + "lineNumber": 175 + }, + "signature": [ + "(() => void) | undefined" + ] + } + ], + "source": { + "path": "x-pack/plugins/cases/common/ui/types.ts", + "lineNumber": 168 + }, + "initialIsOpen": false + } + ], + "enums": [ + { + "id": "def-common.AssociationType", + "type": "Enum", + "label": "AssociationType", + "tags": [], + "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 + }, + "initialIsOpen": false + }, + { + "id": "def-common.CaseStatuses", + "type": "Enum", + "label": "CaseStatuses", + "tags": [], + "description": [], + "source": { + "path": "x-pack/plugins/cases/common/api/cases/status.ts", + "lineNumber": 10 + }, + "initialIsOpen": false + }, + { + "id": "def-common.CaseType", + "type": "Enum", + "label": "CaseType", + "tags": [], + "description": [], + "source": { + "path": "x-pack/plugins/cases/common/api/cases/case.ts", + "lineNumber": 17 + }, + "initialIsOpen": false + }, + { + "id": "def-common.CommentType", + "type": "Enum", + "label": "CommentType", + "tags": [], + "description": [], + "source": { + "path": "x-pack/plugins/cases/common/api/cases/comment.ts", + "lineNumber": 51 + }, + "initialIsOpen": false + }, + { + "id": "def-common.ConnectorTypes", + "type": "Enum", + "label": "ConnectorTypes", + "tags": [], + "description": [], + "source": { + "path": "x-pack/plugins/cases/common/api/connectors/index.ts", + "lineNumber": 33 + }, + "initialIsOpen": false + }, + { + "id": "def-common.SortFieldCase", + "type": "Enum", + "label": "SortFieldCase", + "tags": [], + "description": [], + "source": { + "path": "x-pack/plugins/cases/common/ui/types.ts", + "lineNumber": 119 + }, + "initialIsOpen": false + } + ], + "misc": [ + { + "tags": [], + "id": "def-common.ACTION_TYPES_URL", + "type": "string", + "label": "ACTION_TYPES_URL", + "description": [], + "source": { + "path": "x-pack/plugins/cases/common/constants.ts", + "lineNumber": 41 + }, + "signature": [ + "\"/api/actions/list_action_types\"" + ], + "initialIsOpen": false + }, + { + "tags": [], + "id": "def-common.ACTION_URL", + "type": "string", + "label": "ACTION_URL", + "description": [ + "\nAction routes" + ], + "source": { + "path": "x-pack/plugins/cases/common/constants.ts", + "lineNumber": 40 + }, + "signature": [ + "\"/api/actions\"" + ], + "initialIsOpen": false + }, + { + "id": "def-common.ActionConnector", + "type": "Type", + "label": "ActionConnector", + "tags": [], + "description": [], + "source": { + "path": "x-pack/plugins/cases/common/api/connectors/index.ts", + "lineNumber": 22 + }, + "signature": [ + "ActionResult" + ], + "initialIsOpen": false + }, + { + "id": "def-common.ActionType", + "type": "Type", + "label": "ActionType", + "tags": [], + "description": [], + "source": { + "path": "x-pack/plugins/cases/common/api/connectors/mappings.ts", + "lineNumber": 22 + }, + "signature": [ + "\"append\" | \"overwrite\" | \"nothing\"" + ], + "initialIsOpen": false + }, + { + "id": "def-common.ActionTypeConnector", + "type": "Type", + "label": "ActionTypeConnector", + "tags": [], + "description": [], + "source": { + "path": "x-pack/plugins/cases/common/api/connectors/index.ts", + "lineNumber": 23 + }, + "signature": [ + "ActionType" + ], + "initialIsOpen": false + }, + { + "id": "def-common.AllCommentsResponse", + "type": "Type", + "label": "AllCommentsResponse", + "tags": [], + "description": [], + "source": { + "path": "x-pack/plugins/cases/common/api/cases/comment.ts", + "lineNumber": 135 + }, + "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; }))[]" + ], + "initialIsOpen": false + }, + { + "tags": [], + "id": "def-common.APP_ID", + "type": "string", + "label": "APP_ID", + "description": [], + "source": { + "path": "x-pack/plugins/cases/common/constants.ts", + "lineNumber": 10 + }, + "signature": [ + "\"cases\"" + ], + "initialIsOpen": false + }, + { + "id": "def-common.AttributesTypeAlerts", + "type": "Type", + "label": "AttributesTypeAlerts", + "tags": [], + "description": [], + "source": { + "path": "x-pack/plugins/cases/common/api/cases/comment.ts", + "lineNumber": 130 + }, + "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; }" + ], + "initialIsOpen": false + }, + { + "tags": [], + "id": "def-common.CASE_ALERTS_URL", + "type": "string", + "label": "CASE_ALERTS_URL", + "description": [], + "source": { + "path": "x-pack/plugins/cases/common/constants.ts", + "lineNumber": 34 + }, + "initialIsOpen": false + }, + { + "tags": [], + "id": "def-common.CASE_COMMENT_DETAILS_URL", + "type": "string", + "label": "CASE_COMMENT_DETAILS_URL", + "description": [], + "source": { + "path": "x-pack/plugins/cases/common/constants.ts", + "lineNumber": 27 + }, + "initialIsOpen": false + }, + { + "tags": [], + "id": "def-common.CASE_COMMENTS_URL", + "type": "string", + "label": "CASE_COMMENTS_URL", + "description": [], + "source": { + "path": "x-pack/plugins/cases/common/constants.ts", + "lineNumber": 26 + }, + "initialIsOpen": false + }, + { + "tags": [], + "id": "def-common.CASE_CONFIGURE_CONNECTORS_URL", + "type": "string", + "label": "CASE_CONFIGURE_CONNECTORS_URL", + "description": [], + "source": { + "path": "x-pack/plugins/cases/common/constants.ts", + "lineNumber": 19 + }, + "initialIsOpen": false + }, + { + "tags": [], + "id": "def-common.CASE_CONFIGURE_URL", + "type": "string", + "label": "CASE_CONFIGURE_URL", + "description": [], + "source": { + "path": "x-pack/plugins/cases/common/constants.ts", + "lineNumber": 18 + }, + "initialIsOpen": false + }, + { + "tags": [], + "id": "def-common.CASE_DETAILS_URL", + "type": "string", + "label": "CASE_DETAILS_URL", + "description": [], + "source": { + "path": "x-pack/plugins/cases/common/constants.ts", + "lineNumber": 17 + }, + "initialIsOpen": false + }, + { + "tags": [], + "id": "def-common.CASE_PUSH_URL", + "type": "string", + "label": "CASE_PUSH_URL", + "description": [], + "source": { + "path": "x-pack/plugins/cases/common/constants.ts", + "lineNumber": 28 + }, + "initialIsOpen": false + }, + { + "tags": [], + "id": "def-common.CASE_REPORTERS_URL", + "type": "string", + "label": "CASE_REPORTERS_URL", + "description": [], + "source": { + "path": "x-pack/plugins/cases/common/constants.ts", + "lineNumber": 29 + }, + "initialIsOpen": false + }, + { + "tags": [], + "id": "def-common.CASE_STATUS_URL", + "type": "string", + "label": "CASE_STATUS_URL", + "description": [], + "source": { + "path": "x-pack/plugins/cases/common/constants.ts", + "lineNumber": 30 + }, + "initialIsOpen": false + }, + { + "tags": [], + "id": "def-common.CASE_TAGS_URL", + "type": "string", + "label": "CASE_TAGS_URL", + "description": [], + "source": { + "path": "x-pack/plugins/cases/common/constants.ts", + "lineNumber": 31 + }, + "initialIsOpen": false + }, + { + "tags": [], + "id": "def-common.CASE_USER_ACTIONS_URL", + "type": "string", + "label": "CASE_USER_ACTIONS_URL", + "description": [], + "source": { + "path": "x-pack/plugins/cases/common/constants.ts", + "lineNumber": 32 + }, + "initialIsOpen": false + }, + { + "id": "def-common.CaseAttributes", + "type": "Type", + "label": "CaseAttributes", + "tags": [], + "description": [], + "source": { + "path": "x-pack/plugins/cases/common/api/cases/case.ts", + "lineNumber": 175 + }, + "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" + } + ], + "initialIsOpen": false + }, + { + "id": "def-common.CaseConnector", + "type": "Type", + "label": "CaseConnector", + "tags": [], + "description": [], + "source": { + "path": "x-pack/plugins/cases/common/api/connectors/index.ts", + "lineNumber": 82 + }, + "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" + } + ], + "initialIsOpen": false + }, + { + "id": "def-common.CaseField", + "type": "Type", + "label": "CaseField", + "tags": [], + "description": [], + "source": { + "path": "x-pack/plugins/cases/common/api/connectors/mappings.ts", + "lineNumber": 23 + }, + "signature": [ + "\"description\" | \"title\" | \"comments\"" + ], + "initialIsOpen": false + }, + { + "id": "def-common.CaseFullExternalService", + "type": "Type", + "label": "CaseFullExternalService", + "tags": [], + "description": [], + "source": { + "path": "x-pack/plugins/cases/common/api/cases/case.ts", + "lineNumber": 189 + }, + "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; }; }" + ], + "initialIsOpen": false + }, + { + "id": "def-common.CasePatchRequest", + "type": "Type", + "label": "CasePatchRequest", + "tags": [], + "description": [], + "source": { + "path": "x-pack/plugins/cases/common/api/cases/case.ts", + "lineNumber": 187 + }, + "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" + } + ], + "initialIsOpen": false + }, + { + "id": "def-common.CasePostRequest", + "type": "Type", + "label": "CasePostRequest", + "tags": [], + "description": [], + "source": { + "path": "x-pack/plugins/cases/common/api/cases/case.ts", + "lineNumber": 182 + }, + "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" + } + ], + "initialIsOpen": false + }, + { + "id": "def-common.CaseResponse", + "type": "Type", + "label": "CaseResponse", + "tags": [], + "description": [], + "source": { + "path": "x-pack/plugins/cases/common/api/cases/case.ts", + "lineNumber": 183 + }, + "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" + } + ], + "initialIsOpen": false + }, + { + "tags": [], + "id": "def-common.CASES_URL", + "type": "string", + "label": "CASES_URL", + "description": [ + "\nCase routes" + ], + "source": { + "path": "x-pack/plugins/cases/common/constants.ts", + "lineNumber": 16 + }, + "signature": [ + "\"/api/cases\"" + ], + "initialIsOpen": false + }, + { + "id": "def-common.CasesClientPostRequest", + "type": "Type", + "label": "CasesClientPostRequest", + "tags": [], + "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." + ], + "source": { + "path": "x-pack/plugins/cases/common/api/cases/case.ts", + "lineNumber": 181 + }, + "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" + } + ], + "initialIsOpen": false + }, + { + "id": "def-common.CasesConfigure", + "type": "Type", + "label": "CasesConfigure", + "tags": [], + "description": [], + "source": { + "path": "x-pack/plugins/cases/common/api/cases/configure.ts", + "lineNumber": 47 + }, + "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" + } + ], + "initialIsOpen": false + }, + { + "id": "def-common.CasesConfigureAttributes", + "type": "Type", + "label": "CasesConfigureAttributes", + "tags": [], + "description": [], + "source": { + "path": "x-pack/plugins/cases/common/api/cases/configure.ts", + "lineNumber": 50 + }, + "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" + } + ], + "initialIsOpen": false + }, + { + "id": "def-common.CasesConfigurePatch", + "type": "Type", + "label": "CasesConfigurePatch", + "tags": [], + "description": [], + "source": { + "path": "x-pack/plugins/cases/common/api/cases/configure.ts", + "lineNumber": 49 + }, + "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" + } + ], + "initialIsOpen": false + }, + { + "id": "def-common.CasesConfigureRequest", + "type": "Type", + "label": "CasesConfigureRequest", + "tags": [], + "description": [], + "source": { + "path": "x-pack/plugins/cases/common/api/cases/configure.ts", + "lineNumber": 48 + }, + "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" + } + ], + "initialIsOpen": false + }, + { + "id": "def-common.CasesConfigureResponse", + "type": "Type", + "label": "CasesConfigureResponse", + "tags": [], + "description": [], + "source": { + "path": "x-pack/plugins/cases/common/api/cases/configure.ts", + "lineNumber": 51 + }, + "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" + } + ], + "initialIsOpen": false + }, + { + "id": "def-common.CaseSettings", + "type": "Type", + "label": "CaseSettings", + "tags": [], + "description": [], + "source": { + "path": "x-pack/plugins/cases/common/api/cases/case.ts", + "lineNumber": 190 + }, + "signature": [ + "{ syncAlerts: boolean; }" + ], + "initialIsOpen": false + }, + { + "id": "def-common.CasesFindRequest", + "type": "Type", + "label": "CasesFindRequest", + "tags": [], + "description": [], + "source": { + "path": "x-pack/plugins/cases/common/api/cases/case.ts", + "lineNumber": 185 + }, + "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; }" + ], + "initialIsOpen": false + }, + { + "id": "def-common.CasesFindResponse", + "type": "Type", + "label": "CasesFindResponse", + "tags": [], + "description": [], + "source": { + "path": "x-pack/plugins/cases/common/api/cases/case.ts", + "lineNumber": 186 + }, + "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" + } + ], + "initialIsOpen": false + }, + { + "id": "def-common.CasesPatchRequest", + "type": "Type", + "label": "CasesPatchRequest", + "tags": [], + "description": [], + "source": { + "path": "x-pack/plugins/cases/common/api/cases/case.ts", + "lineNumber": 188 + }, + "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" + } + ], + "initialIsOpen": false + }, + { + "id": "def-common.CasesResponse", + "type": "Type", + "label": "CasesResponse", + "tags": [], + "description": [], + "source": { + "path": "x-pack/plugins/cases/common/api/cases/case.ts", + "lineNumber": 184 + }, + "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" + } + ], + "initialIsOpen": false + }, + { + "id": "def-common.CasesStatusResponse", + "type": "Type", + "label": "CasesStatusResponse", + "tags": [], + "description": [], + "source": { + "path": "x-pack/plugins/cases/common/api/cases/status.ts", + "lineNumber": 30 + }, + "signature": [ + "{ count_open_cases: number; count_in_progress_cases: number; count_closed_cases: number; }" + ], + "initialIsOpen": false + }, + { + "tags": [], + "id": "def-common.caseStatuses", + "type": "Array", + "label": "caseStatuses", + "description": [], + "source": { + "path": "x-pack/plugins/cases/common/api/cases/status.ts", + "lineNumber": 22 + }, + "signature": [ + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.CaseStatuses", + "text": "CaseStatuses" + }, + "[]" + ], + "initialIsOpen": false + }, + { + "id": "def-common.CaseStatusWithAllStatus", + "type": "Type", + "label": "CaseStatusWithAllStatus", + "tags": [], + "description": [], + "source": { + "path": "x-pack/plugins/cases/common/ui/types.ts", + "lineNumber": 24 + }, + "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" + ], + "initialIsOpen": false + }, + { + "tags": [], + "id": "def-common.caseTypeField", + "type": "string", + "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." + ], + "source": { + "path": "x-pack/plugins/cases/common/api/cases/case.ts", + "lineNumber": 25 + }, + "signature": [ + "\"type\"" + ], + "initialIsOpen": false + }, + { + "id": "def-common.CaseUserActionAttributes", + "type": "Type", + "label": "CaseUserActionAttributes", + "tags": [], + "description": [], + "source": { + "path": "x-pack/plugins/cases/common/api/cases/user_actions.ts", + "lineNumber": 59 + }, + "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; }" + ], + "initialIsOpen": false + }, + { + "id": "def-common.CaseUserActionsResponse", + "type": "Type", + "label": "CaseUserActionsResponse", + "tags": [], + "description": [], + "source": { + "path": "x-pack/plugins/cases/common/api/cases/user_actions.ts", + "lineNumber": 60 + }, + "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; })[]" + ], + "initialIsOpen": false + }, + { + "id": "def-common.ClosureType", + "type": "Type", + "label": "ClosureType", + "tags": [], + "description": [], + "source": { + "path": "x-pack/plugins/cases/common/api/cases/configure.ts", + "lineNumber": 46 + }, + "signature": [ + "\"close-by-user\" | \"close-by-pushing\"" + ], + "initialIsOpen": false + }, + { + "id": "def-common.Comment", + "type": "Type", + "label": "Comment", + "tags": [], + "description": [], + "source": { + "path": "x-pack/plugins/cases/common/ui/types.ts", + "lineNumber": 26 + }, + "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" + } + ], + "initialIsOpen": false + }, + { + "id": "def-common.CommentAttributes", + "type": "Type", + "label": "CommentAttributes", + "tags": [], + "description": [], + "source": { + "path": "x-pack/plugins/cases/common/api/cases/comment.ts", + "lineNumber": 131 + }, + "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" + } + ], + "initialIsOpen": false + }, + { + "id": "def-common.CommentPatchAttributes", + "type": "Type", + "label": "CommentPatchAttributes", + "tags": [], + "description": [], + "source": { + "path": "x-pack/plugins/cases/common/api/cases/comment.ts", + "lineNumber": 138 + }, + "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; }" + ], + "initialIsOpen": false + }, + { + "id": "def-common.CommentPatchRequest", + "type": "Type", + "label": "CommentPatchRequest", + "tags": [], + "description": [], + "source": { + "path": "x-pack/plugins/cases/common/api/cases/comment.ts", + "lineNumber": 137 + }, + "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; }" + ], + "initialIsOpen": false + }, + { + "id": "def-common.CommentRequest", + "type": "Type", + "label": "CommentRequest", + "tags": [], + "description": [], + "source": { + "path": "x-pack/plugins/cases/common/api/cases/comment.ts", + "lineNumber": 132 + }, + "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; }; }" + ], + "initialIsOpen": false + }, + { + "id": "def-common.CommentRequestAlertType", + "type": "Type", + "label": "CommentRequestAlertType", + "tags": [], + "description": [], + "source": { + "path": "x-pack/plugins/cases/common/api/cases/comment.ts", + "lineNumber": 140 + }, + "signature": [ + "{ type: CommentType.alert | CommentType.generatedAlert; alertId: string | string[]; index: string | string[]; rule: { id: string | null; name: string | null; }; }" + ], + "initialIsOpen": false + }, + { + "id": "def-common.CommentRequestUserType", + "type": "Type", + "label": "CommentRequestUserType", + "tags": [], + "description": [], + "source": { + "path": "x-pack/plugins/cases/common/api/cases/comment.ts", + "lineNumber": 139 + }, + "signature": [ + "{ comment: string; type: CommentType.user; }" + ], + "initialIsOpen": false + }, + { + "id": "def-common.CommentResponse", + "type": "Type", + "label": "CommentResponse", + "tags": [], + "description": [], + "source": { + "path": "x-pack/plugins/cases/common/api/cases/comment.ts", + "lineNumber": 133 + }, + "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" + } + ], + "initialIsOpen": false + }, + { + "id": "def-common.CommentResponseAlertsType", + "type": "Type", + "label": "CommentResponseAlertsType", + "tags": [], + "description": [], + "source": { + "path": "x-pack/plugins/cases/common/api/cases/comment.ts", + "lineNumber": 134 + }, + "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; }" + ], + "initialIsOpen": false + }, + { + "id": "def-common.CommentsResponse", + "type": "Type", + "label": "CommentsResponse", + "tags": [], + "description": [], + "source": { + "path": "x-pack/plugins/cases/common/api/cases/comment.ts", + "lineNumber": 136 + }, + "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; }" + ], + "initialIsOpen": false + }, + { + "id": "def-common.ConnectorField", + "type": "Type", + "label": "ConnectorField", + "tags": [], + "description": [], + "source": { + "path": "x-pack/plugins/cases/common/api/connectors/mappings.ts", + "lineNumber": 48 + }, + "signature": [ + "{ id: string; name: string; required: boolean; type: \"text\" | \"textarea\"; }" + ], + "initialIsOpen": false + }, + { + "id": "def-common.ConnectorFields", + "type": "Type", + "label": "ConnectorFields", + "tags": [], + "description": [], + "source": { + "path": "x-pack/plugins/cases/common/api/connectors/index.ts", + "lineNumber": 92 + }, + "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; }" + ], + "initialIsOpen": false + }, + { + "id": "def-common.ConnectorJiraTypeFields", + "type": "Type", + "label": "ConnectorJiraTypeFields", + "tags": [], + "description": [], + "source": { + "path": "x-pack/plugins/cases/common/api/connectors/index.ts", + "lineNumber": 84 + }, + "signature": [ + "{ type: ConnectorTypes.jira; fields: { issueType: string | null; priority: string | null; parent: string | null; } | null; }" + ], + "initialIsOpen": false + }, + { + "id": "def-common.ConnectorMappings", + "type": "Type", + "label": "ConnectorMappings", + "tags": [], + "description": [], + "source": { + "path": "x-pack/plugins/cases/common/api/connectors/mappings.ts", + "lineNumber": 37 + }, + "signature": [ + "{ mappings: { action_type: \"append\" | \"overwrite\" | \"nothing\"; source: \"description\" | \"title\" | \"comments\"; target: string; }[]; }" + ], + "initialIsOpen": false + }, + { + "id": "def-common.ConnectorMappingsAttributes", + "type": "Type", + "label": "ConnectorMappingsAttributes", + "tags": [], + "description": [], + "source": { + "path": "x-pack/plugins/cases/common/api/connectors/mappings.ts", + "lineNumber": 36 + }, + "signature": [ + "{ action_type: \"append\" | \"overwrite\" | \"nothing\"; source: \"description\" | \"title\" | \"comments\"; target: string; }" + ], + "initialIsOpen": false + }, + { + "id": "def-common.ConnectorResillientTypeFields", + "type": "Type", + "label": "ConnectorResillientTypeFields", + "tags": [], + "description": [], + "source": { + "path": "x-pack/plugins/cases/common/api/connectors/index.ts", + "lineNumber": 85 + }, + "signature": [ + "{ type: ConnectorTypes.resilient; fields: { incidentTypes: string[] | null; severityCode: string | null; } | null; }" + ], + "initialIsOpen": false + }, + { + "id": "def-common.ConnectorServiceNowITSMTypeFields", + "type": "Type", + "label": "ConnectorServiceNowITSMTypeFields", + "tags": [], + "description": [], + "source": { + "path": "x-pack/plugins/cases/common/api/connectors/index.ts", + "lineNumber": 86 + }, + "signature": [ + "{ type: ConnectorTypes.serviceNowITSM; fields: { impact: string | null; severity: string | null; urgency: string | null; category: string | null; subcategory: string | null; } | null; }" + ], + "initialIsOpen": false + }, + { + "id": "def-common.ConnectorServiceNowSIRTypeFields", + "type": "Type", + "label": "ConnectorServiceNowSIRTypeFields", + "tags": [], + "description": [], + "source": { + "path": "x-pack/plugins/cases/common/api/connectors/index.ts", + "lineNumber": 89 + }, + "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; }" + ], + "initialIsOpen": false + }, + { + "id": "def-common.ConnectorTypeFields", + "type": "Type", + "label": "ConnectorTypeFields", + "tags": [], + "description": [], + "source": { + "path": "x-pack/plugins/cases/common/api/connectors/index.ts", + "lineNumber": 83 + }, + "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" + } + ], + "initialIsOpen": false + }, + { + "tags": [], + "id": "def-common.DEFAULT_DATE_FORMAT", + "type": "string", + "label": "DEFAULT_DATE_FORMAT", + "description": [], + "source": { + "path": "x-pack/plugins/cases/common/constants.ts", + "lineNumber": 7 + }, + "signature": [ + "\"dateFormat\"" + ], + "initialIsOpen": false + }, + { + "tags": [], + "id": "def-common.DEFAULT_DATE_FORMAT_TZ", + "type": "string", + "label": "DEFAULT_DATE_FORMAT_TZ", + "description": [], + "source": { + "path": "x-pack/plugins/cases/common/constants.ts", + "lineNumber": 8 + }, + "signature": [ + "\"dateFormat:tz\"" + ], + "initialIsOpen": false + }, + { + "tags": [], + "id": "def-common.ENABLE_CASE_CONNECTOR", + "type": "boolean", + "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." + ], + "source": { + "path": "x-pack/plugins/cases/common/constants.ts", + "lineNumber": 63 + }, + "signature": [ + "false" + ], + "initialIsOpen": false + }, + { + "id": "def-common.ESCaseAttributes", + "type": "Type", + "label": "ESCaseAttributes", + "tags": [], + "description": [], + "source": { + "path": "x-pack/plugins/cases/common/api/cases/case.ts", + "lineNumber": 193 + }, + "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" + } + ], + "initialIsOpen": false + }, + { + "id": "def-common.ESCaseConnectorTypes", + "type": "Type", + "label": "ESCaseConnectorTypes", + "tags": [], + "description": [], + "source": { + "path": "x-pack/plugins/cases/common/api/connectors/index.ts", + "lineNumber": 99 + }, + "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" + } + ], + "initialIsOpen": false + }, + { + "id": "def-common.ESCasePatchRequest", + "type": "Type", + "label": "ESCasePatchRequest", + "tags": [], + "description": [], + "source": { + "path": "x-pack/plugins/cases/common/api/cases/case.ts", + "lineNumber": 194 + }, + "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" + } + ], + "initialIsOpen": false + }, + { + "id": "def-common.ESCasesConfigureAttributes", + "type": "Type", + "label": "ESCasesConfigureAttributes", + "tags": [], + "description": [], + "source": { + "path": "x-pack/plugins/cases/common/api/cases/configure.ts", + "lineNumber": 53 + }, + "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" + } + ], + "initialIsOpen": false + }, + { + "id": "def-common.ESConnectorFields", + "type": "Type", + "label": "ESConnectorFields", + "tags": [], + "description": [], + "source": { + "path": "x-pack/plugins/cases/common/api/connectors/index.ts", + "lineNumber": 94 + }, + "signature": [ + "{ key: string; value: unknown; }[]" + ], + "initialIsOpen": false + }, + { + "id": "def-common.ExternalServiceResponse", + "type": "Type", + "label": "ExternalServiceResponse", + "tags": [], + "description": [], + "source": { + "path": "x-pack/plugins/cases/common/api/cases/case.ts", + "lineNumber": 191 + }, + "signature": [ + "{ title: string; id: string; pushedDate: string; url: string; } & { comments?: ({ commentId: string; pushedDate: string; } & { externalCommentId?: string | undefined; })[] | undefined; }" + ], + "initialIsOpen": false + }, + { + "id": "def-common.GetCaseIdsByAlertIdAggs", + "type": "Type", + "label": "GetCaseIdsByAlertIdAggs", + "tags": [], + "description": [], + "source": { + "path": "x-pack/plugins/cases/common/api/cases/comment.ts", + "lineNumber": 141 + }, + "signature": [ + "{ references: { doc_count: number; caseIds: { buckets: { key: string; }[]; }; }; }" + ], + "initialIsOpen": false + }, + { + "id": "def-common.GetFieldsResponse", + "type": "Type", + "label": "GetFieldsResponse", + "tags": [], + "description": [], + "source": { + "path": "x-pack/plugins/cases/common/api/connectors/mappings.ts", + "lineNumber": 55 + }, + "signature": [ + "{ defaultMappings: { action_type: \"append\" | \"overwrite\" | \"nothing\"; source: \"description\" | \"title\" | \"comments\"; target: string; }[]; fields: { id: string; name: string; required: boolean; type: \"text\" | \"textarea\"; }[]; }" + ], + "initialIsOpen": false + }, + { + "tags": [], + "id": "def-common.JIRA_ACTION_TYPE_ID", + "type": "string", + "label": "JIRA_ACTION_TYPE_ID", + "description": [], + "source": { + "path": "x-pack/plugins/cases/common/constants.ts", + "lineNumber": 44 + }, + "signature": [ + "\".jira\"" + ], + "initialIsOpen": false + }, + { + "id": "def-common.JiraFieldsType", + "type": "Type", + "label": "JiraFieldsType", + "tags": [], + "description": [], + "source": { + "path": "x-pack/plugins/cases/common/api/connectors/jira.ts", + "lineNumber": 17 + }, + "signature": [ + "{ issueType: string | null; priority: string | null; parent: string | null; }" + ], + "initialIsOpen": false + }, + { + "tags": [], + "id": "def-common.MAX_ALERTS_PER_SUB_CASE", + "type": "number", + "label": "MAX_ALERTS_PER_SUB_CASE", + "description": [ + "\nAlerts" + ], + "source": { + "path": "x-pack/plugins/cases/common/constants.ts", + "lineNumber": 57 + }, + "signature": [ + "5000" + ], + "initialIsOpen": false + }, + { + "tags": [], + "id": "def-common.MAX_GENERATED_ALERTS_PER_SUB_CASE", + "type": "number", + "label": "MAX_GENERATED_ALERTS_PER_SUB_CASE", + "description": [], + "source": { + "path": "x-pack/plugins/cases/common/constants.ts", + "lineNumber": 58 + }, + "signature": [ + "50" + ], + "initialIsOpen": false + }, + { + "tags": [], + "id": "def-common.RESILIENT_ACTION_TYPE_ID", + "type": "string", + "label": "RESILIENT_ACTION_TYPE_ID", + "description": [], + "source": { + "path": "x-pack/plugins/cases/common/constants.ts", + "lineNumber": 45 + }, + "signature": [ + "\".resilient\"" + ], + "initialIsOpen": false + }, + { + "id": "def-common.ResilientFieldsType", + "type": "Type", + "label": "ResilientFieldsType", + "tags": [], + "description": [], + "source": { + "path": "x-pack/plugins/cases/common/api/connectors/resilient.ts", + "lineNumber": 16 + }, + "signature": [ + "{ incidentTypes: string[] | null; severityCode: string | null; }" + ], + "initialIsOpen": false + }, + { + "id": "def-common.SavedObjectFindOptions", + "type": "Type", + "label": "SavedObjectFindOptions", + "tags": [], + "description": [], + "source": { + "path": "x-pack/plugins/cases/common/api/saved_object.ts", + "lineNumber": 39 + }, + "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; }" + ], + "initialIsOpen": false + }, + { + "tags": [], + "id": "def-common.SERVICENOW_ITSM_ACTION_TYPE_ID", + "type": "string", + "label": "SERVICENOW_ITSM_ACTION_TYPE_ID", + "description": [], + "source": { + "path": "x-pack/plugins/cases/common/constants.ts", + "lineNumber": 42 + }, + "signature": [ + "\".servicenow\"" + ], + "initialIsOpen": false + }, + { + "tags": [], + "id": "def-common.SERVICENOW_SIR_ACTION_TYPE_ID", + "type": "string", + "label": "SERVICENOW_SIR_ACTION_TYPE_ID", + "description": [], + "source": { + "path": "x-pack/plugins/cases/common/constants.ts", + "lineNumber": 43 + }, + "signature": [ + "\".servicenow-sir\"" + ], + "initialIsOpen": false + }, + { + "id": "def-common.ServiceNowITSMFieldsType", + "type": "Type", + "label": "ServiceNowITSMFieldsType", + "tags": [], + "description": [], + "source": { + "path": "x-pack/plugins/cases/common/api/connectors/servicenow_itsm.ts", + "lineNumber": 19 + }, + "signature": [ + "{ impact: string | null; severity: string | null; urgency: string | null; category: string | null; subcategory: string | null; }" + ], + "initialIsOpen": false + }, + { + "id": "def-common.ServiceNowSIRFieldsType", + "type": "Type", + "label": "ServiceNowSIRFieldsType", + "tags": [], + "description": [], + "source": { + "path": "x-pack/plugins/cases/common/api/connectors/servicenow_sir.ts", + "lineNumber": 21 + }, + "signature": [ + "{ category: string | null; destIp: boolean | null; malwareHash: boolean | null; malwareUrl: boolean | null; priority: string | null; sourceIp: boolean | null; subcategory: string | null; }" + ], + "initialIsOpen": false + }, + { + "tags": [], + "id": "def-common.StatusAll", + "type": "string", + "label": "StatusAll", + "description": [], + "source": { + "path": "x-pack/plugins/cases/common/ui/types.ts", + "lineNumber": 21 + }, + "signature": [ + "\"all\"" + ], + "initialIsOpen": false + }, + { + "id": "def-common.StatusAllType", + "type": "Type", + "label": "StatusAllType", + "tags": [], + "description": [], + "source": { + "path": "x-pack/plugins/cases/common/ui/types.ts", + "lineNumber": 22 + }, + "signature": [ + "\"all\"" + ], + "initialIsOpen": false + }, + { + "tags": [], + "id": "def-common.SUB_CASE_DETAILS_URL", + "type": "string", + "label": "SUB_CASE_DETAILS_URL", + "description": [], + "source": { + "path": "x-pack/plugins/cases/common/constants.ts", + "lineNumber": 23 + }, + "initialIsOpen": false + }, + { + "tags": [], + "id": "def-common.SUB_CASE_USER_ACTIONS_URL", + "type": "string", + "label": "SUB_CASE_USER_ACTIONS_URL", + "description": [], + "source": { + "path": "x-pack/plugins/cases/common/constants.ts", + "lineNumber": 24 + }, + "initialIsOpen": false + }, + { + "tags": [], + "id": "def-common.SUB_CASES_PATCH_DEL_URL", + "type": "string", + "label": "SUB_CASES_PATCH_DEL_URL", + "description": [], + "source": { + "path": "x-pack/plugins/cases/common/constants.ts", + "lineNumber": 21 + }, + "initialIsOpen": false + }, + { + "tags": [], + "id": "def-common.SUB_CASES_URL", + "type": "string", + "label": "SUB_CASES_URL", + "description": [], + "source": { + "path": "x-pack/plugins/cases/common/constants.ts", + "lineNumber": 22 + }, + "initialIsOpen": false + }, + { + "id": "def-common.SubCaseAttributes", + "type": "Type", + "label": "SubCaseAttributes", + "tags": [], + "description": [], + "source": { + "path": "x-pack/plugins/cases/common/api/cases/sub_case.ts", + "lineNumber": 75 + }, + "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; }" + ], + "initialIsOpen": false + }, + { + "id": "def-common.SubCasePatchRequest", + "type": "Type", + "label": "SubCasePatchRequest", + "tags": [], + "description": [], + "source": { + "path": "x-pack/plugins/cases/common/api/cases/sub_case.ts", + "lineNumber": 79 + }, + "signature": [ + "{ status?: ", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.CaseStatuses", + "text": "CaseStatuses" + }, + " | undefined; } & { id: string; version: string; }" + ], + "initialIsOpen": false + }, + { + "id": "def-common.SubCaseResponse", + "type": "Type", + "label": "SubCaseResponse", + "tags": [], + "description": [], + "source": { + "path": "x-pack/plugins/cases/common/api/cases/sub_case.ts", + "lineNumber": 76 + }, + "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" + } + ], + "initialIsOpen": false + }, + { + "id": "def-common.SubCasesFindResponse", + "type": "Type", + "label": "SubCasesFindResponse", + "tags": [], + "description": [], + "source": { + "path": "x-pack/plugins/cases/common/api/cases/sub_case.ts", + "lineNumber": 78 + }, + "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" + } + ], + "initialIsOpen": false + }, + { + "id": "def-common.SubCasesPatchRequest", + "type": "Type", + "label": "SubCasesPatchRequest", + "tags": [], + "description": [], + "source": { + "path": "x-pack/plugins/cases/common/api/cases/sub_case.ts", + "lineNumber": 80 + }, + "signature": [ + "{ subCases: ({ status?: ", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.CaseStatuses", + "text": "CaseStatuses" + }, + " | undefined; } & { id: string; version: string; })[]; }" + ], + "initialIsOpen": false + }, + { + "id": "def-common.SubCasesResponse", + "type": "Type", + "label": "SubCasesResponse", + "tags": [], + "description": [], + "source": { + "path": "x-pack/plugins/cases/common/api/cases/sub_case.ts", + "lineNumber": 77 + }, + "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" + } + ], + "initialIsOpen": false + }, + { + "tags": [], + "id": "def-common.SUPPORTED_CONNECTORS", + "type": "Array", + "label": "SUPPORTED_CONNECTORS", + "description": [], + "source": { + "path": "x-pack/plugins/cases/common/constants.ts", + "lineNumber": 47 + }, + "signature": [ + "string[]" + ], + "initialIsOpen": false + }, + { + "id": "def-common.ThirdPartyField", + "type": "Type", + "label": "ThirdPartyField", + "tags": [], + "description": [], + "source": { + "path": "x-pack/plugins/cases/common/api/connectors/mappings.ts", + "lineNumber": 24 + }, + "signature": [ + "string" + ], + "initialIsOpen": false + }, + { + "id": "def-common.UpdateKey", + "type": "Type", + "label": "UpdateKey", + "tags": [], + "description": [], + "source": { + "path": "x-pack/plugins/cases/common/ui/types.ts", + "lineNumber": 163 + }, + "signature": [ + "\"status\" | \"description\" | \"title\" | \"tags\" | \"settings\" | \"connector\"" + ], + "initialIsOpen": false + }, + { + "id": "def-common.User", + "type": "Type", + "label": "User", + "tags": [], + "description": [], + "source": { + "path": "x-pack/plugins/cases/common/api/user.ts", + "lineNumber": 18 + }, + "signature": [ + "{ email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; }" + ], + "initialIsOpen": false + }, + { + "id": "def-common.UserAction", + "type": "Type", + "label": "UserAction", + "tags": [], + "description": [], + "source": { + "path": "x-pack/plugins/cases/common/api/cases/user_actions.ts", + "lineNumber": 62 + }, + "signature": [ + "\"add\" | \"delete\" | \"create\" | \"update\" | \"push-to-service\"" + ], + "initialIsOpen": false + }, + { + "id": "def-common.UserActionField", + "type": "Type", + "label": "UserActionField", + "tags": [], + "description": [], + "source": { + "path": "x-pack/plugins/cases/common/api/cases/user_actions.ts", + "lineNumber": 63 + }, + "signature": [ + "(\"status\" | \"description\" | \"title\" | \"comment\" | \"tags\" | \"settings\" | \"connector\" | \"pushed\" | \"sub_case\")[]" + ], + "initialIsOpen": false + }, + { + "id": "def-common.UserActionFieldType", + "type": "Type", + "label": "UserActionFieldType", + "tags": [], + "description": [], + "source": { + "path": "x-pack/plugins/cases/common/api/cases/user_actions.ts", + "lineNumber": 64 + }, + "signature": [ + "\"status\" | \"description\" | \"title\" | \"comment\" | \"tags\" | \"settings\" | \"connector\" | \"pushed\" | \"sub_case\"" + ], + "initialIsOpen": false + } + ], + "objects": [ + { + "tags": [], + "id": "def-common.AlertCommentRequestRt", + "type": "Object", + "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." + ], + "source": { + "path": "x-pack/plugins/cases/common/api/cases/comment.ts", + "lineNumber": 67 + }, + "signature": [ + "TypeC", + "<{ type: ", + "UnionC", + "<[", + "LiteralC", + "<", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.CommentType", + "text": "CommentType" + }, + ".generatedAlert>, ", + "LiteralC" + ], + "initialIsOpen": false + }, + { + "tags": [], + "id": "def-common.AllCommentsResponseRt", + "type": "Object", + "label": "AllCommentsResponseRt", + "description": [], + "source": { + "path": "x-pack/plugins/cases/common/api/cases/comment.ts", + "lineNumber": 128 + }, + "signature": [ + "ArrayC", + "<", + "IntersectionC", + "<[", + "UnionC", + "<[", + "IntersectionC", + "<[", + "TypeC" + ], + "initialIsOpen": false + }, + { + "tags": [], + "id": "def-common.AllCommentsResponseRT", + "type": "Object", + "label": "AllCommentsResponseRT", + "description": [], + "source": { + "path": "x-pack/plugins/cases/common/api/cases/comment.ts", + "lineNumber": 99 + }, + "signature": [ + "ArrayC", + "<", + "IntersectionC", + "<[", + "UnionC", + "<[", + "IntersectionC", + "<[", + "TypeC" + ], + "initialIsOpen": false + }, + { + "tags": [], + "id": "def-common.CaseAttributesRt", + "type": "Object", + "label": "CaseAttributesRt", + "description": [], + "source": { + "path": "x-pack/plugins/cases/common/api/cases/case.ts", + "lineNumber": 62 + }, + "signature": [ + "IntersectionC", + "<[", + "TypeC", + "<{ description: ", + "StringC", + "; status: ", + "UnionC", + "<[", + "LiteralC" + ], + "initialIsOpen": false + }, + { + "tags": [], + "id": "def-common.CaseConfigureAttributesRt", + "type": "Object", + "label": "CaseConfigureAttributesRt", + "description": [], + "source": { + "path": "x-pack/plugins/cases/common/api/cases/configure.ts", + "lineNumber": 27 + }, + "signature": [ + "IntersectionC", + "<[", + "TypeC", + "<{ connector: ", + "IntersectionC", + "<[", + "TypeC", + "<{ id: ", + "StringC" + ], + "initialIsOpen": false + }, + { + "tags": [], + "id": "def-common.CaseConfigureResponseRt", + "type": "Object", + "label": "CaseConfigureResponseRt", + "description": [], + "source": { + "path": "x-pack/plugins/cases/common/api/cases/configure.ts", + "lineNumber": 37 + }, + "signature": [ + "IntersectionC", + "<[", + "IntersectionC", + "<[", + "TypeC", + "<{ connector: ", + "IntersectionC", + "<[", + "TypeC" + ], + "initialIsOpen": false + }, + { + "tags": [], + "id": "def-common.CaseConnectorRt", + "type": "Object", + "label": "CaseConnectorRt", + "description": [], + "source": { + "path": "x-pack/plugins/cases/common/api/connectors/index.ts", + "lineNumber": 74 + }, + "signature": [ + "IntersectionC", + "<[", + "TypeC", + "<{ id: ", + "StringC", + "; name: ", + "StringC", + "; }>, ", + "UnionC" + ], + "initialIsOpen": false + }, + { + "tags": [], + "id": "def-common.CasePatchRequestRt", + "type": "Object", + "label": "CasePatchRequestRt", + "description": [], + "source": { + "path": "x-pack/plugins/cases/common/api/cases/case.ts", + "lineNumber": 142 + }, + "signature": [ + "IntersectionC", + "<[", + "PartialC", + "<{ description: ", + "StringC", + "; status: ", + "UnionC", + "<[", + "LiteralC" + ], + "initialIsOpen": false + }, + { + "tags": [], + "id": "def-common.CasePostRequestRt", + "type": "Object", + "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." + ], + "source": { + "path": "x-pack/plugins/cases/common/api/cases/case.ts", + "lineNumber": 97 + }, + "signature": [ + "IntersectionC", + "<[", + "PartialC", + "<{ type: ", + "UnionC", + "<[", + "LiteralC", + "<", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.CaseType", + "text": "CaseType" + } + ], + "initialIsOpen": false + }, + { + "tags": [], + "id": "def-common.CasePushRequestParamsRt", + "type": "Object", + "label": "CasePushRequestParamsRt", + "description": [], + "source": { + "path": "x-pack/plugins/cases/common/api/cases/case.ts", + "lineNumber": 150 + }, + "signature": [ + "TypeC", + "<{ case_id: ", + "StringC", + "; connector_id: ", + "StringC", + "; }>" + ], + "initialIsOpen": false + }, + { + "tags": [], + "id": "def-common.CaseResponseRt", + "type": "Object", + "label": "CaseResponseRt", + "description": [], + "source": { + "path": "x-pack/plugins/cases/common/api/cases/case.ts", + "lineNumber": 117 + }, + "signature": [ + "IntersectionC", + "<[", + "IntersectionC", + "<[", + "TypeC", + "<{ description: ", + "StringC", + "; status: ", + "UnionC" + ], + "initialIsOpen": false + }, + { + "tags": [], + "id": "def-common.CasesClientPostRequestRt", + "type": "Object", + "label": "CasesClientPostRequestRt", + "description": [ + "\nThis type is used for validating a create case request. It requires that the type field be defined." + ], + "source": { + "path": "x-pack/plugins/cases/common/api/cases/case.ts", + "lineNumber": 86 + }, + "signature": [ + "TypeC", + "<{ type: ", + "UnionC", + "<[", + "LiteralC", + "<", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.CaseType", + "text": "CaseType" + }, + ".collection>, ", + "LiteralC" + ], + "initialIsOpen": false + }, + { + "tags": [], + "id": "def-common.CasesConfigurePatchRt", + "type": "Object", + "label": "CasesConfigurePatchRt", + "description": [], + "source": { + "path": "x-pack/plugins/cases/common/api/cases/configure.ts", + "lineNumber": 22 + }, + "signature": [ + "IntersectionC", + "<[", + "PartialC", + "<{ connector: ", + "IntersectionC", + "<[", + "TypeC", + "<{ id: ", + "StringC" + ], + "initialIsOpen": false + }, + { + "tags": [], + "id": "def-common.CasesConfigureRequestRt", + "type": "Object", + "label": "CasesConfigureRequestRt", + "description": [], + "source": { + "path": "x-pack/plugins/cases/common/api/cases/configure.ts", + "lineNumber": 21 + }, + "signature": [ + "TypeC", + "<{ connector: ", + "IntersectionC", + "<[", + "TypeC", + "<{ id: ", + "StringC", + "; name: ", + "StringC" + ], + "initialIsOpen": false + }, + { + "tags": [], + "id": "def-common.CasesFindRequestRt", + "type": "Object", + "label": "CasesFindRequestRt", + "description": [], + "source": { + "path": "x-pack/plugins/cases/common/api/cases/case.ts", + "lineNumber": 102 + }, + "signature": [ + "PartialC", + "<{ type: ", + "UnionC", + "<[", + "LiteralC", + "<", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.CaseType", + "text": "CaseType" + }, + ".collection>, ", + "LiteralC" + ], + "initialIsOpen": false + }, + { + "tags": [], + "id": "def-common.CasesFindResponseRt", + "type": "Object", + "label": "CasesFindResponseRt", + "description": [], + "source": { + "path": "x-pack/plugins/cases/common/api/cases/case.ts", + "lineNumber": 132 + }, + "signature": [ + "IntersectionC", + "<[", + "TypeC", + "<{ cases: ", + "ArrayC", + "<", + "IntersectionC", + "<[", + "IntersectionC" + ], + "initialIsOpen": false + }, + { + "tags": [], + "id": "def-common.CasesPatchRequestRt", + "type": "Object", + "label": "CasesPatchRequestRt", + "description": [], + "source": { + "path": "x-pack/plugins/cases/common/api/cases/case.ts", + "lineNumber": 147 + }, + "signature": [ + "TypeC", + "<{ cases: ", + "ArrayC", + "<", + "IntersectionC", + "<[", + "PartialC", + "<{ description: ", + "StringC" + ], + "initialIsOpen": false + }, + { + "tags": [], + "id": "def-common.CasesResponseRt", + "type": "Object", + "label": "CasesResponseRt", + "description": [], + "source": { + "path": "x-pack/plugins/cases/common/api/cases/case.ts", + "lineNumber": 148 + }, + "signature": [ + "ArrayC", + "<", + "IntersectionC", + "<[", + "IntersectionC", + "<[", + "TypeC", + "<{ description: ", + "StringC" + ], + "initialIsOpen": false + }, + { + "tags": [], + "id": "def-common.CasesStatusResponseRt", + "type": "Object", + "label": "CasesStatusResponseRt", + "description": [], + "source": { + "path": "x-pack/plugins/cases/common/api/cases/status.ts", + "lineNumber": 24 + }, + "signature": [ + "TypeC", + "<{ count_open_cases: ", + "NumberC", + "; count_in_progress_cases: ", + "NumberC", + "; count_closed_cases: ", + "NumberC", + "; }>" + ], + "initialIsOpen": false + }, + { + "tags": [], + "id": "def-common.CaseStatusRt", + "type": "Object", + "label": "CaseStatusRt", + "description": [], + "source": { + "path": "x-pack/plugins/cases/common/api/cases/status.ts", + "lineNumber": 16 + }, + "signature": [ + "UnionC", + "<[", + "LiteralC", + "<", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.CaseStatuses", + "text": "CaseStatuses" + }, + ".open>, ", + "LiteralC", + ", ", + "LiteralC" + ], + "initialIsOpen": false + }, + { + "tags": [], + "id": "def-common.CaseUserActionsResponseRt", + "type": "Object", + "label": "CaseUserActionsResponseRt", + "description": [], + "source": { + "path": "x-pack/plugins/cases/common/api/cases/user_actions.ts", + "lineNumber": 57 + }, + "signature": [ + "ArrayC", + "<", + "IntersectionC", + "<[", + "TypeC", + "<{ action_field: ", + "ArrayC", + "<", + "UnionC" + ], + "initialIsOpen": false + }, + { + "tags": [], + "id": "def-common.CommentAttributesBasicRt", + "type": "Object", + "label": "CommentAttributesBasicRt", + "description": [], + "source": { + "path": "x-pack/plugins/cases/common/api/cases/comment.ts", + "lineNumber": 38 + }, + "signature": [ + "TypeC", + "<{ associationType: ", + "UnionC", + "<[", + "LiteralC", + "<", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.AssociationType", + "text": "AssociationType" + }, + ".case>, ", + "LiteralC" + ], + "initialIsOpen": false + }, + { + "tags": [], + "id": "def-common.CommentPatchAttributesRt", + "type": "Object", + "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." + ], + "source": { + "path": "x-pack/plugins/cases/common/api/cases/comment.ts", + "lineNumber": 116 + }, + "signature": [ + "IntersectionC", + "<[", + "UnionC", + "<[", + "PartialC", + "<{ associationType: ", + "UnionC", + "<[", + "LiteralC" + ], + "initialIsOpen": false + }, + { + "tags": [], + "id": "def-common.CommentPatchRequestRt", + "type": "Object", + "label": "CommentPatchRequestRt", + "description": [], + "source": { + "path": "x-pack/plugins/cases/common/api/cases/comment.ts", + "lineNumber": 101 + }, + "signature": [ + "IntersectionC", + "<[", + "UnionC", + "<[", + "TypeC", + "<{ comment: ", + "StringC", + "; type: ", + "LiteralC" + ], + "initialIsOpen": false + }, + { + "tags": [], + "id": "def-common.CommentRequestRt", + "type": "Object", + "label": "CommentRequestRt", + "description": [], + "source": { + "path": "x-pack/plugins/cases/common/api/cases/comment.ts", + "lineNumber": 81 + }, + "signature": [ + "UnionC", + "<[", + "TypeC", + "<{ comment: ", + "StringC", + "; type: ", + "LiteralC", + "<", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.CommentType", + "text": "CommentType" + } + ], + "initialIsOpen": false + }, + { + "tags": [], + "id": "def-common.CommentResponseRt", + "type": "Object", + "label": "CommentResponseRt", + "description": [], + "source": { + "path": "x-pack/plugins/cases/common/api/cases/comment.ts", + "lineNumber": 83 + }, + "signature": [ + "IntersectionC", + "<[", + "UnionC", + "<[", + "IntersectionC", + "<[", + "TypeC", + "<{ comment: ", + "StringC" + ], + "initialIsOpen": false + }, + { + "tags": [], + "id": "def-common.CommentResponseTypeAlertsRt", + "type": "Object", + "label": "CommentResponseTypeAlertsRt", + "description": [], + "source": { + "path": "x-pack/plugins/cases/common/api/cases/comment.ts", + "lineNumber": 91 + }, + "signature": [ + "IntersectionC", + "<[", + "IntersectionC", + "<[", + "TypeC", + "<{ type: ", + "UnionC", + "<[", + "LiteralC" + ], + "initialIsOpen": false + }, + { + "tags": [], + "id": "def-common.CommentsResponseRt", + "type": "Object", + "label": "CommentsResponseRt", + "description": [], + "source": { + "path": "x-pack/plugins/cases/common/api/cases/comment.ts", + "lineNumber": 121 + }, + "signature": [ + "TypeC", + "<{ comments: ", + "ArrayC", + "<", + "IntersectionC", + "<[", + "UnionC", + "<[", + "IntersectionC" + ], + "initialIsOpen": false + }, + { + "tags": [], + "id": "def-common.ConnectorFieldsRt", + "type": "Object", + "label": "ConnectorFieldsRt", + "description": [], + "source": { + "path": "x-pack/plugins/cases/common/api/connectors/index.ts", + "lineNumber": 25 + }, + "signature": [ + "UnionC", + "<[", + "TypeC", + "<{ issueType: ", + "UnionC", + "<[", + "StringC", + ", ", + "NullC" + ], + "initialIsOpen": false + }, + { + "tags": [], + "id": "def-common.ConnectorMappingsAttributesRT", + "type": "Object", + "label": "ConnectorMappingsAttributesRT", + "description": [], + "source": { + "path": "x-pack/plugins/cases/common/api/connectors/mappings.ts", + "lineNumber": 26 + }, + "signature": [ + "TypeC", + "<{ action_type: ", + "UnionC", + "<[", + "LiteralC", + "<\"append\">, ", + "LiteralC", + "<\"nothing\">, ", + "LiteralC" + ], + "initialIsOpen": false + }, + { + "tags": [], + "id": "def-common.ConnectorMappingsRt", + "type": "Object", + "label": "ConnectorMappingsRt", + "description": [], + "source": { + "path": "x-pack/plugins/cases/common/api/connectors/mappings.ts", + "lineNumber": 32 + }, + "signature": [ + "TypeC", + "<{ mappings: ", + "ArrayC", + "<", + "TypeC", + "<{ action_type: ", + "UnionC", + "<[", + "LiteralC" + ], + "initialIsOpen": false + }, + { + "tags": [], + "id": "def-common.ConnectorTypeFieldsRt", + "type": "Object", + "label": "ConnectorTypeFieldsRt", + "description": [], + "source": { + "path": "x-pack/plugins/cases/common/api/connectors/index.ts", + "lineNumber": 66 + }, + "signature": [ + "UnionC", + "<[", + "TypeC", + "<{ type: ", + "LiteralC", + "<", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.ConnectorTypes", + "text": "ConnectorTypes" + }, + ".jira>; fields: ", + "UnionC" + ], + "initialIsOpen": false + }, + { + "tags": [], + "id": "def-common.ContextTypeUserRt", + "type": "Object", + "label": "ContextTypeUserRt", + "description": [], + "source": { + "path": "x-pack/plugins/cases/common/api/cases/comment.ts", + "lineNumber": 57 + }, + "signature": [ + "TypeC", + "<{ comment: ", + "StringC", + "; type: ", + "LiteralC", + "<", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.CommentType", + "text": "CommentType" + }, + ".user>; }>" + ], + "initialIsOpen": false + }, + { + "tags": [], + "id": "def-common.ExternalServiceResponseRt", + "type": "Object", + "label": "ExternalServiceResponseRt", + "description": [], + "source": { + "path": "x-pack/plugins/cases/common/api/cases/case.ts", + "lineNumber": 155 + }, + "signature": [ + "IntersectionC", + "<[", + "TypeC", + "<{ title: ", + "StringC", + "; id: ", + "StringC", + "; pushedDate: ", + "StringC" + ], + "initialIsOpen": false + }, + { + "tags": [], + "id": "def-common.GetCaseIdsByAlertIdAggsRt", + "type": "Object", + "label": "GetCaseIdsByAlertIdAggsRt", + "description": [], + "source": { + "path": "x-pack/plugins/cases/common/api/cases/comment.ts", + "lineNumber": 18 + }, + "signature": [ + "TypeC", + "<{ references: ", + "TypeC", + "<{ doc_count: ", + "NumberC", + "; caseIds: ", + "TypeC", + "<{ buckets: ", + "ArrayC" + ], + "initialIsOpen": false + }, + { + "tags": [], + "id": "def-common.JiraFieldsRT", + "type": "Object", + "label": "JiraFieldsRT", + "description": [], + "source": { + "path": "x-pack/plugins/cases/common/api/connectors/jira.ts", + "lineNumber": 11 + }, + "signature": [ + "TypeC", + "<{ issueType: ", + "UnionC", + "<[", + "StringC", + ", ", + "NullC", + "]>; priority: ", + "UnionC" + ], + "initialIsOpen": false + }, + { + "tags": [], + "id": "def-common.NumberFromString", + "type": "Object", + "label": "NumberFromString", + "description": [], + "source": { + "path": "x-pack/plugins/cases/common/api/saved_object.ts", + "lineNumber": 12 + }, + "signature": [ + "Type", + "" + ], + "initialIsOpen": false + }, + { + "tags": [], + "id": "def-common.ResilientFieldsRT", + "type": "Object", + "label": "ResilientFieldsRT", + "description": [], + "source": { + "path": "x-pack/plugins/cases/common/api/connectors/resilient.ts", + "lineNumber": 11 + }, + "signature": [ + "TypeC", + "<{ incidentTypes: ", + "UnionC", + "<[", + "ArrayC", + "<", + "StringC", + ">, ", + "NullC" + ], + "initialIsOpen": false + }, + { + "tags": [], + "id": "def-common.SavedObjectFindOptionsRt", + "type": "Object", + "label": "SavedObjectFindOptionsRt", + "description": [], + "source": { + "path": "x-pack/plugins/cases/common/api/saved_object.ts", + "lineNumber": 25 + }, + "signature": [ + "PartialC", + "<{ defaultSearchOperator: ", + "UnionC", + "<[", + "LiteralC", + "<\"AND\">, ", + "LiteralC", + "<\"OR\">]>; hasReferenceOperator: ", + "UnionC" + ], + "initialIsOpen": false + }, + { + "tags": [], + "id": "def-common.ServiceNowITSMFieldsRT", + "type": "Object", + "label": "ServiceNowITSMFieldsRT", + "description": [], + "source": { + "path": "x-pack/plugins/cases/common/api/connectors/servicenow_itsm.ts", + "lineNumber": 11 + }, + "signature": [ + "TypeC", + "<{ impact: ", + "UnionC", + "<[", + "StringC", + ", ", + "NullC", + "]>; severity: ", + "UnionC" + ], + "initialIsOpen": false + }, + { + "tags": [], + "id": "def-common.ServiceNowSIRFieldsRT", + "type": "Object", + "label": "ServiceNowSIRFieldsRT", + "description": [], + "source": { + "path": "x-pack/plugins/cases/common/api/connectors/servicenow_sir.ts", + "lineNumber": 11 + }, + "signature": [ + "TypeC", + "<{ category: ", + "UnionC", + "<[", + "StringC", + ", ", + "NullC", + "]>; destIp: ", + "UnionC" + ], + "initialIsOpen": false + }, + { + "tags": [], + "id": "def-common.SubCaseAttributesRt", + "type": "Object", + "label": "SubCaseAttributesRt", + "description": [], + "source": { + "path": "x-pack/plugins/cases/common/api/cases/sub_case.ts", + "lineNumber": 20 + }, + "signature": [ + "IntersectionC", + "<[", + "TypeC", + "<{ status: ", + "UnionC", + "<[", + "LiteralC", + "<", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.CaseStatuses", + "text": "CaseStatuses" + } + ], + "initialIsOpen": false + }, + { + "tags": [], + "id": "def-common.SubCasePatchRequestRt", + "type": "Object", + "label": "SubCasePatchRequestRt", + "description": [], + "source": { + "path": "x-pack/plugins/cases/common/api/cases/sub_case.ts", + "lineNumber": 67 + }, + "signature": [ + "IntersectionC", + "<[", + "PartialC", + "<{ status: ", + "UnionC", + "<[", + "LiteralC", + "<", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.CaseStatuses", + "text": "CaseStatuses" + } + ], + "initialIsOpen": false + }, + { + "tags": [], + "id": "def-common.SubCaseResponseRt", + "type": "Object", + "label": "SubCaseResponseRt", + "description": [], + "source": { + "path": "x-pack/plugins/cases/common/api/cases/sub_case.ts", + "lineNumber": 44 + }, + "signature": [ + "IntersectionC", + "<[", + "IntersectionC", + "<[", + "TypeC", + "<{ status: ", + "UnionC", + "<[", + "LiteralC" + ], + "initialIsOpen": false + }, + { + "tags": [], + "id": "def-common.SubCasesFindRequestRt", + "type": "Object", + "label": "SubCasesFindRequestRt", + "description": [], + "source": { + "path": "x-pack/plugins/cases/common/api/cases/sub_case.ts", + "lineNumber": 32 + }, + "signature": [ + "PartialC", + "<{ status: ", + "UnionC", + "<[", + "LiteralC", + "<", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.CaseStatuses", + "text": "CaseStatuses" + }, + ".open>, ", + "LiteralC" + ], + "initialIsOpen": false + }, + { + "tags": [], + "id": "def-common.SubCasesFindResponseRt", + "type": "Object", + "label": "SubCasesFindResponseRt", + "description": [], + "source": { + "path": "x-pack/plugins/cases/common/api/cases/sub_case.ts", + "lineNumber": 57 + }, + "signature": [ + "IntersectionC", + "<[", + "TypeC", + "<{ subCases: ", + "ArrayC", + "<", + "IntersectionC", + "<[", + "IntersectionC" + ], + "initialIsOpen": false + }, + { + "tags": [], + "id": "def-common.SubCasesPatchRequestRt", + "type": "Object", + "label": "SubCasesPatchRequestRt", + "description": [], + "source": { + "path": "x-pack/plugins/cases/common/api/cases/sub_case.ts", + "lineNumber": 72 + }, + "signature": [ + "TypeC", + "<{ subCases: ", + "ArrayC", + "<", + "IntersectionC", + "<[", + "PartialC", + "<{ status: ", + "UnionC" + ], + "initialIsOpen": false + }, + { + "tags": [], + "id": "def-common.SubCasesResponseRt", + "type": "Object", + "label": "SubCasesResponseRt", + "description": [], + "source": { + "path": "x-pack/plugins/cases/common/api/cases/sub_case.ts", + "lineNumber": 73 + }, + "signature": [ + "ArrayC", + "<", + "IntersectionC", + "<[", + "IntersectionC", + "<[", + "TypeC", + "<{ status: ", + "UnionC" + ], + "initialIsOpen": false + }, + { + "tags": [], + "id": "def-common.UserRT", + "type": "Object", + "label": "UserRT", + "description": [], + "source": { + "path": "x-pack/plugins/cases/common/api/user.ts", + "lineNumber": 10 + }, + "signature": [ + "TypeC", + "<{ email: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC", + ", ", + "StringC" + ], + "initialIsOpen": false + }, + { + "tags": [], + "id": "def-common.UsersRt", + "type": "Object", + "label": "UsersRt", + "description": [], + "source": { + "path": "x-pack/plugins/cases/common/api/user.ts", + "lineNumber": 16 + }, + "signature": [ + "ArrayC", + "<", + "TypeC", + "<{ email: ", + "UnionC", + "<[", + "UndefinedC", + ", ", + "NullC" + ], + "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/cloud.json b/api_docs/cloud.json index 1ac97f2fac5b3..cb20e5640d1d1 100644 --- a/api_docs/cloud.json +++ b/api_docs/cloud.json @@ -121,7 +121,7 @@ "description": [], "source": { "path": "x-pack/plugins/cloud/public/plugin.ts", - "lineNumber": 35 + "lineNumber": 36 }, "signature": [ "string | undefined" @@ -135,7 +135,7 @@ "description": [], "source": { "path": "x-pack/plugins/cloud/public/plugin.ts", - "lineNumber": 36 + "lineNumber": 37 }, "signature": [ "string | undefined" @@ -149,7 +149,7 @@ "description": [], "source": { "path": "x-pack/plugins/cloud/public/plugin.ts", - "lineNumber": 37 + "lineNumber": 38 }, "signature": [ "string | undefined" @@ -163,7 +163,7 @@ "description": [], "source": { "path": "x-pack/plugins/cloud/public/plugin.ts", - "lineNumber": 38 + "lineNumber": 39 }, "signature": [ "string | undefined" @@ -177,7 +177,7 @@ "description": [], "source": { "path": "x-pack/plugins/cloud/public/plugin.ts", - "lineNumber": 39 + "lineNumber": 40 }, "signature": [ "string | undefined" @@ -191,7 +191,7 @@ "description": [], "source": { "path": "x-pack/plugins/cloud/public/plugin.ts", - "lineNumber": 40 + "lineNumber": 41 }, "signature": [ "string | undefined" @@ -205,13 +205,13 @@ "description": [], "source": { "path": "x-pack/plugins/cloud/public/plugin.ts", - "lineNumber": 41 + "lineNumber": 42 } } ], "source": { "path": "x-pack/plugins/cloud/public/plugin.ts", - "lineNumber": 34 + "lineNumber": 35 }, "lifecycle": "setup", "initialIsOpen": true @@ -239,7 +239,21 @@ "description": [], "source": { "path": "x-pack/plugins/cloud/server/plugin.ts", - "lineNumber": 19 + "lineNumber": 20 + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [], + "id": "def-server.CloudSetup.deploymentId", + "type": "string", + "label": "deploymentId", + "description": [], + "source": { + "path": "x-pack/plugins/cloud/server/plugin.ts", + "lineNumber": 21 }, "signature": [ "string | undefined" @@ -253,7 +267,7 @@ "description": [], "source": { "path": "x-pack/plugins/cloud/server/plugin.ts", - "lineNumber": 20 + "lineNumber": 22 } }, { @@ -264,7 +278,7 @@ "description": [], "source": { "path": "x-pack/plugins/cloud/server/plugin.ts", - "lineNumber": 21 + "lineNumber": 23 }, "signature": [ "{ url?: string | undefined; secretToken?: string | undefined; }" @@ -273,7 +287,7 @@ ], "source": { "path": "x-pack/plugins/cloud/server/plugin.ts", - "lineNumber": 18 + "lineNumber": 19 }, "lifecycle": "setup", "initialIsOpen": true diff --git a/api_docs/core.json b/api_docs/core.json index 9695aaebdd313..dd84c72be0c2a 100644 --- a/api_docs/core.json +++ b/api_docs/core.json @@ -1026,7 +1026,7 @@ ], "source": { "path": "src/core/public/index.ts", - "lineNumber": 210 + "lineNumber": 215 }, "signature": [ { @@ -1048,7 +1048,7 @@ ], "source": { "path": "src/core/public/index.ts", - "lineNumber": 212 + "lineNumber": 217 }, "signature": [ { @@ -1070,7 +1070,7 @@ ], "source": { "path": "src/core/public/index.ts", - "lineNumber": 214 + "lineNumber": 219 }, "signature": [ { @@ -1092,7 +1092,7 @@ ], "source": { "path": "src/core/public/index.ts", - "lineNumber": 216 + "lineNumber": 221 }, "signature": [ { @@ -1114,7 +1114,7 @@ ], "source": { "path": "src/core/public/index.ts", - "lineNumber": 218 + "lineNumber": 223 }, "signature": [ { @@ -1138,7 +1138,7 @@ ], "source": { "path": "src/core/public/index.ts", - "lineNumber": 225 + "lineNumber": 230 }, "signature": [ "{ getInjectedVar: (name: string, defaultValue?: any) => unknown; }" @@ -1154,7 +1154,7 @@ ], "source": { "path": "src/core/public/index.ts", - "lineNumber": 229 + "lineNumber": 234 }, "signature": [ { @@ -1170,7 +1170,7 @@ ], "source": { "path": "src/core/public/index.ts", - "lineNumber": 208 + "lineNumber": 213 }, "initialIsOpen": false }, @@ -1195,7 +1195,7 @@ ], "source": { "path": "src/core/public/index.ts", - "lineNumber": 255 + "lineNumber": 260 }, "signature": [ { @@ -1217,7 +1217,7 @@ ], "source": { "path": "src/core/public/index.ts", - "lineNumber": 257 + "lineNumber": 262 }, "signature": [ { @@ -1239,7 +1239,7 @@ ], "source": { "path": "src/core/public/index.ts", - "lineNumber": 259 + "lineNumber": 264 }, "signature": [ { @@ -1261,7 +1261,7 @@ ], "source": { "path": "src/core/public/index.ts", - "lineNumber": 261 + "lineNumber": 266 }, "signature": [ { @@ -1283,7 +1283,7 @@ ], "source": { "path": "src/core/public/index.ts", - "lineNumber": 263 + "lineNumber": 268 }, "signature": [ { @@ -1305,7 +1305,7 @@ ], "source": { "path": "src/core/public/index.ts", - "lineNumber": 265 + "lineNumber": 270 }, "signature": [ { @@ -1327,7 +1327,7 @@ ], "source": { "path": "src/core/public/index.ts", - "lineNumber": 267 + "lineNumber": 272 }, "signature": [ { @@ -1349,7 +1349,7 @@ ], "source": { "path": "src/core/public/index.ts", - "lineNumber": 269 + "lineNumber": 274 }, "signature": [ { @@ -1371,7 +1371,7 @@ ], "source": { "path": "src/core/public/index.ts", - "lineNumber": 271 + "lineNumber": 276 }, "signature": [ { @@ -1393,7 +1393,7 @@ ], "source": { "path": "src/core/public/index.ts", - "lineNumber": 273 + "lineNumber": 278 }, "signature": [ { @@ -1415,7 +1415,7 @@ ], "source": { "path": "src/core/public/index.ts", - "lineNumber": 275 + "lineNumber": 280 }, "signature": [ { @@ -1439,7 +1439,7 @@ ], "source": { "path": "src/core/public/index.ts", - "lineNumber": 282 + "lineNumber": 287 }, "signature": [ "{ getInjectedVar: (name: string, defaultValue?: any) => unknown; }" @@ -1448,7 +1448,7 @@ ], "source": { "path": "src/core/public/index.ts", - "lineNumber": 253 + "lineNumber": 258 }, "initialIsOpen": false }, @@ -1567,7 +1567,7 @@ "description": [], "source": { "path": "src/core/public/doc_links/doc_links_service.ts", - "lineNumber": 349 + "lineNumber": 408 } }, { @@ -1578,7 +1578,7 @@ "description": [], "source": { "path": "src/core/public/doc_links/doc_links_service.ts", - "lineNumber": 350 + "lineNumber": 409 } }, { @@ -1589,16 +1589,52 @@ "description": [], "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; }" + "{ 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": 348 + "lineNumber": 407 + }, + "initialIsOpen": false + }, + { + "id": "def-public.DomainDeprecationDetails", + "type": "Interface", + "label": "DomainDeprecationDetails", + "signature": [ + "DomainDeprecationDetails", + " extends ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.DeprecationsDetails", + "text": "DeprecationsDetails" + } + ], + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-public.DomainDeprecationDetails.domainId", + "type": "string", + "label": "domainId", + "description": [], + "source": { + "path": "src/core/server/deprecations/types.ts", + "lineNumber": 15 + } + } + ], + "source": { + "path": "src/core/server/deprecations/types.ts", + "lineNumber": 14 }, "initialIsOpen": false }, @@ -2032,22 +2068,6 @@ "(key: string, value: any) => Promise" ] }, - { - "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": [], "id": "def-public.IUiSettingsClient.remove", @@ -2058,7 +2078,7 @@ ], "source": { "path": "src/core/public/ui_settings/types.ts", - "lineNumber": 67 + "lineNumber": 61 }, "signature": [ "(key: string) => Promise" @@ -2074,7 +2094,7 @@ ], "source": { "path": "src/core/public/ui_settings/types.ts", - "lineNumber": 73 + "lineNumber": 67 }, "signature": [ "(key: string) => boolean" @@ -2090,7 +2110,7 @@ ], "source": { "path": "src/core/public/ui_settings/types.ts", - "lineNumber": 78 + "lineNumber": 72 }, "signature": [ "(key: string) => boolean" @@ -2106,7 +2126,7 @@ ], "source": { "path": "src/core/public/ui_settings/types.ts", - "lineNumber": 85 + "lineNumber": 79 }, "signature": [ "(key: string) => boolean" @@ -2122,7 +2142,7 @@ ], "source": { "path": "src/core/public/ui_settings/types.ts", - "lineNumber": 90 + "lineNumber": 84 }, "signature": [ "(key: string) => boolean" @@ -2138,25 +2158,7 @@ ], "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": [ "() => ", @@ -2174,7 +2176,7 @@ ], "source": { "path": "src/core/public/ui_settings/types.ts", - "lineNumber": 116 + "lineNumber": 100 }, "signature": [ "() => ", @@ -3955,7 +3957,7 @@ ], "source": { "path": "src/core/server/saved_objects/types.ts", - "lineNumber": 142 + "lineNumber": 164 }, "signature": [ "string | undefined" @@ -3964,7 +3966,7 @@ ], "source": { "path": "src/core/server/saved_objects/types.ts", - "lineNumber": 140 + "lineNumber": 162 }, "initialIsOpen": false }, @@ -4206,6 +4208,26 @@ "any" ] }, + { + "tags": [ + "alpha" + ], + "id": "def-public.SavedObjectsFindOptions.aggs", + "type": "Object", + "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" + ], + "source": { + "path": "src/core/server/saved_objects/types.ts", + "lineNumber": 140 + }, + "signature": [ + "Record | undefined" + ] + }, { "tags": [], "id": "def-public.SavedObjectsFindOptions.namespaces", @@ -4214,7 +4236,7 @@ "description": [], "source": { "path": "src/core/server/saved_objects/types.ts", - "lineNumber": 119 + "lineNumber": 141 }, "signature": [ "string[] | undefined" @@ -4230,7 +4252,7 @@ ], "source": { "path": "src/core/server/saved_objects/types.ts", - "lineNumber": 127 + "lineNumber": 149 }, "signature": [ "Map | undefined" @@ -4246,7 +4268,7 @@ ], "source": { "path": "src/core/server/saved_objects/types.ts", - "lineNumber": 129 + "lineNumber": 151 }, "signature": [ "string | undefined" @@ -4262,7 +4284,7 @@ ], "source": { "path": "src/core/server/saved_objects/types.ts", - "lineNumber": 133 + "lineNumber": 155 }, "signature": [ { @@ -5620,6 +5642,25 @@ ], "enums": [], "misc": [ + { + "tags": [ + "public" + ], + "id": "def-public.APP_WRAPPER_CLASS", + "type": "string", + "label": "APP_WRAPPER_CLASS", + "description": [ + "\nThe class name for top level *and* nested application wrappers to ensure proper layout" + ], + "source": { + "path": "src/core/utils/app_wrapper_class.ts", + "lineNumber": 13 + }, + "signature": [ + "\"kbnAppWrapper\"" + ], + "initialIsOpen": false + }, { "id": "def-public.FatalErrorsStart", "type": "Type", @@ -5737,7 +5778,7 @@ "description": [], "source": { "path": "src/core/server/plugins/types.ts", - "lineNumber": 84 + "lineNumber": 117 }, "signature": [ "symbol" @@ -5866,7 +5907,7 @@ ], "source": { "path": "src/core/server/saved_objects/types.ts", - "lineNumber": 227 + "lineNumber": 249 }, "signature": [ "\"multiple\" | \"single\" | \"multiple-isolated\" | \"agnostic\"" @@ -5885,7 +5926,7 @@ ], "source": { "path": "src/core/public/index.ts", - "lineNumber": 239 + "lineNumber": 244 }, "signature": [ "() => Promise<[", @@ -6183,7 +6224,7 @@ "description": [], "source": { "path": "src/core/server/csp/csp_config.ts", - "lineNumber": 47 + "lineNumber": 53 }, "signature": [ { @@ -6203,7 +6244,7 @@ "description": [], "source": { "path": "src/core/server/csp/csp_config.ts", - "lineNumber": 49 + "lineNumber": 55 }, "signature": [ "string[]" @@ -6217,7 +6258,7 @@ "description": [], "source": { "path": "src/core/server/csp/csp_config.ts", - "lineNumber": 50 + "lineNumber": 56 } }, { @@ -6228,7 +6269,18 @@ "description": [], "source": { "path": "src/core/server/csp/csp_config.ts", - "lineNumber": 51 + "lineNumber": 57 + } + }, + { + "tags": [], + "id": "def-server.CspConfig.disableEmbedding", + "type": "boolean", + "label": "disableEmbedding", + "description": [], + "source": { + "path": "src/core/server/csp/csp_config.ts", + "lineNumber": 58 } }, { @@ -6239,13 +6291,13 @@ "description": [], "source": { "path": "src/core/server/csp/csp_config.ts", - "lineNumber": 52 + "lineNumber": 59 } } ], "source": { "path": "src/core/server/csp/csp_config.ts", - "lineNumber": 46 + "lineNumber": 52 }, "initialIsOpen": false }, @@ -7474,7 +7526,7 @@ "description": [], "source": { "path": "src/core/server/plugins/types.ts", - "lineNumber": 274 + "lineNumber": 307 } }, { @@ -7488,7 +7540,7 @@ "description": [], "source": { "path": "src/core/server/plugins/types.ts", - "lineNumber": 274 + "lineNumber": 307 } } ], @@ -7496,7 +7548,7 @@ "returnComment": [], "source": { "path": "src/core/server/plugins/types.ts", - "lineNumber": 274 + "lineNumber": 307 } }, { @@ -7533,7 +7585,7 @@ "description": [], "source": { "path": "src/core/server/plugins/types.ts", - "lineNumber": 276 + "lineNumber": 309 } }, { @@ -7547,7 +7599,7 @@ "description": [], "source": { "path": "src/core/server/plugins/types.ts", - "lineNumber": 276 + "lineNumber": 309 } } ], @@ -7555,7 +7607,7 @@ "returnComment": [], "source": { "path": "src/core/server/plugins/types.ts", - "lineNumber": 276 + "lineNumber": 309 } }, { @@ -7571,13 +7623,13 @@ "returnComment": [], "source": { "path": "src/core/server/plugins/types.ts", - "lineNumber": 278 + "lineNumber": 311 } } ], "source": { "path": "src/core/server/plugins/types.ts", - "lineNumber": 268 + "lineNumber": 301 }, "initialIsOpen": false }, @@ -8203,7 +8255,7 @@ ], "source": { "path": "src/core/server/index.ts", - "lineNumber": 466 + "lineNumber": 474 }, "signature": [ { @@ -8225,7 +8277,7 @@ ], "source": { "path": "src/core/server/index.ts", - "lineNumber": 468 + "lineNumber": 476 }, "signature": [ { @@ -8247,7 +8299,7 @@ ], "source": { "path": "src/core/server/index.ts", - "lineNumber": 470 + "lineNumber": 478 }, "signature": [ { @@ -8269,7 +8321,7 @@ ], "source": { "path": "src/core/server/index.ts", - "lineNumber": 472 + "lineNumber": 480 }, "signature": [ { @@ -8300,7 +8352,7 @@ ], "source": { "path": "src/core/server/index.ts", - "lineNumber": 477 + "lineNumber": 485 }, "signature": [ { @@ -8322,7 +8374,7 @@ ], "source": { "path": "src/core/server/index.ts", - "lineNumber": 479 + "lineNumber": 487 }, "signature": [ { @@ -8344,7 +8396,7 @@ ], "source": { "path": "src/core/server/index.ts", - "lineNumber": 481 + "lineNumber": 489 }, "signature": [ { @@ -8366,7 +8418,7 @@ ], "source": { "path": "src/core/server/index.ts", - "lineNumber": 483 + "lineNumber": 491 }, "signature": [ { @@ -8388,7 +8440,7 @@ ], "source": { "path": "src/core/server/index.ts", - "lineNumber": 485 + "lineNumber": 493 }, "signature": [ { @@ -8410,7 +8462,7 @@ ], "source": { "path": "src/core/server/index.ts", - "lineNumber": 487 + "lineNumber": 495 }, "signature": [ { @@ -8432,7 +8484,7 @@ ], "source": { "path": "src/core/server/index.ts", - "lineNumber": 489 + "lineNumber": 497 }, "signature": [ { @@ -8454,7 +8506,7 @@ ], "source": { "path": "src/core/server/index.ts", - "lineNumber": 491 + "lineNumber": 499 }, "signature": [ { @@ -8470,7 +8522,7 @@ ], "source": { "path": "src/core/server/index.ts", - "lineNumber": 464 + "lineNumber": 472 }, "initialIsOpen": false }, @@ -8495,7 +8547,7 @@ ], "source": { "path": "src/core/server/index.ts", - "lineNumber": 514 + "lineNumber": 522 }, "signature": [ { @@ -8517,7 +8569,7 @@ ], "source": { "path": "src/core/server/index.ts", - "lineNumber": 516 + "lineNumber": 524 }, "signature": [ { @@ -8539,7 +8591,7 @@ ], "source": { "path": "src/core/server/index.ts", - "lineNumber": 518 + "lineNumber": 526 }, "signature": [ { @@ -8561,7 +8613,7 @@ ], "source": { "path": "src/core/server/index.ts", - "lineNumber": 520 + "lineNumber": 528 }, "signature": [ { @@ -8583,7 +8635,7 @@ ], "source": { "path": "src/core/server/index.ts", - "lineNumber": 522 + "lineNumber": 530 }, "signature": [ { @@ -8605,7 +8657,7 @@ ], "source": { "path": "src/core/server/index.ts", - "lineNumber": 524 + "lineNumber": 532 }, "signature": [ { @@ -8620,7 +8672,7 @@ ], "source": { "path": "src/core/server/index.ts", - "lineNumber": 512 + "lineNumber": 520 }, "initialIsOpen": false }, @@ -9251,7 +9303,7 @@ ], "source": { "path": "src/core/server/plugins/types.ts", - "lineNumber": 189 + "lineNumber": 222 } }, { @@ -9264,7 +9316,7 @@ ], "source": { "path": "src/core/server/plugins/types.ts", - "lineNumber": 194 + "lineNumber": 227 }, "signature": [ "string | string[]" @@ -9280,7 +9332,7 @@ ], "source": { "path": "src/core/server/plugins/types.ts", - "lineNumber": 200 + "lineNumber": 233 }, "signature": [ "readonly string[]" @@ -9296,7 +9348,7 @@ ], "source": { "path": "src/core/server/plugins/types.ts", - "lineNumber": 207 + "lineNumber": 240 }, "signature": [ "readonly string[]" @@ -9312,7 +9364,7 @@ ], "source": { "path": "src/core/server/plugins/types.ts", - "lineNumber": 219 + "lineNumber": 252 }, "signature": [ "readonly string[]" @@ -9321,7 +9373,7 @@ ], "source": { "path": "src/core/server/plugins/types.ts", - "lineNumber": 185 + "lineNumber": 218 }, "initialIsOpen": false }, @@ -10473,6 +10525,19 @@ "lineNumber": 33 } }, + { + "tags": [], + "id": "def-server.ICspConfig.disableEmbedding", + "type": "boolean", + "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": "src/core/server/csp/csp_config.ts", + "lineNumber": 39 + } + }, { "tags": [], "id": "def-server.ICspConfig.header", @@ -10483,7 +10548,7 @@ ], "source": { "path": "src/core/server/csp/csp_config.ts", - "lineNumber": 39 + "lineNumber": 45 } } ], @@ -12795,9 +12860,11 @@ "type": "Function", "label": "trace", "signature": [ - "(message: string, meta?: ", + " void" + ">(message: string, meta?: Meta | undefined) => void" ], "description": [ "\nLog messages at the most detailed log level\n" @@ -12816,24 +12883,23 @@ ], "source": { "path": "node_modules/@kbn/logging/target/logger.d.ts", - "lineNumber": 23 + "lineNumber": 16 } }, { "id": "def-server.Logger.trace.$2", - "type": "Object", + "type": "Uncategorized", "label": "meta", "isRequired": false, "signature": [ - "LogMeta", - " | undefined" + "Meta | undefined" ], "description": [ "-" ], "source": { "path": "node_modules/@kbn/logging/target/logger.d.ts", - "lineNumber": 23 + "lineNumber": 16 } } ], @@ -12841,7 +12907,7 @@ "returnComment": [], "source": { "path": "node_modules/@kbn/logging/target/logger.d.ts", - "lineNumber": 23 + "lineNumber": 16 } }, { @@ -12849,9 +12915,11 @@ "type": "Function", "label": "debug", "signature": [ - "(message: string, meta?: ", + " void" + ">(message: string, meta?: Meta | undefined) => void" ], "description": [ "\nLog messages useful for debugging and interactive investigation" @@ -12870,24 +12938,23 @@ ], "source": { "path": "node_modules/@kbn/logging/target/logger.d.ts", - "lineNumber": 29 + "lineNumber": 22 } }, { "id": "def-server.Logger.debug.$2", - "type": "Object", + "type": "Uncategorized", "label": "meta", "isRequired": false, "signature": [ - "LogMeta", - " | undefined" + "Meta | undefined" ], "description": [ "-" ], "source": { "path": "node_modules/@kbn/logging/target/logger.d.ts", - "lineNumber": 29 + "lineNumber": 22 } } ], @@ -12895,7 +12962,7 @@ "returnComment": [], "source": { "path": "node_modules/@kbn/logging/target/logger.d.ts", - "lineNumber": 29 + "lineNumber": 22 } }, { @@ -12903,9 +12970,11 @@ "type": "Function", "label": "info", "signature": [ - "(message: string, meta?: ", + " void" + " = ", + "LogMeta", + ">(message: string, meta?: Meta | undefined) => void" ], "description": [ "\nLogs messages related to general application flow" @@ -12924,24 +12993,23 @@ ], "source": { "path": "node_modules/@kbn/logging/target/logger.d.ts", - "lineNumber": 35 + "lineNumber": 28 } }, { "id": "def-server.Logger.info.$2", - "type": "Object", + "type": "Uncategorized", "label": "meta", "isRequired": false, "signature": [ - "LogMeta", - " | undefined" + "Meta | undefined" ], "description": [ "-" ], "source": { "path": "node_modules/@kbn/logging/target/logger.d.ts", - "lineNumber": 35 + "lineNumber": 28 } } ], @@ -12949,7 +13017,7 @@ "returnComment": [], "source": { "path": "node_modules/@kbn/logging/target/logger.d.ts", - "lineNumber": 35 + "lineNumber": 28 } }, { @@ -12957,9 +13025,11 @@ "type": "Function", "label": "warn", "signature": [ - "(errorOrMessage: string | Error, meta?: ", + " void" + ">(errorOrMessage: string | Error, meta?: Meta | undefined) => void" ], "description": [ "\nLogs abnormal or unexpected errors or messages" @@ -12978,24 +13048,23 @@ ], "source": { "path": "node_modules/@kbn/logging/target/logger.d.ts", - "lineNumber": 41 + "lineNumber": 34 } }, { "id": "def-server.Logger.warn.$2", - "type": "Object", + "type": "Uncategorized", "label": "meta", "isRequired": false, "signature": [ - "LogMeta", - " | undefined" + "Meta | undefined" ], "description": [ "-" ], "source": { "path": "node_modules/@kbn/logging/target/logger.d.ts", - "lineNumber": 41 + "lineNumber": 34 } } ], @@ -13003,7 +13072,7 @@ "returnComment": [], "source": { "path": "node_modules/@kbn/logging/target/logger.d.ts", - "lineNumber": 41 + "lineNumber": 34 } }, { @@ -13011,9 +13080,11 @@ "type": "Function", "label": "error", "signature": [ - "(errorOrMessage: string | Error, meta?: ", + " void" + " = ", + "LogMeta", + ">(errorOrMessage: string | Error, meta?: Meta | undefined) => void" ], "description": [ "\nLogs abnormal or unexpected errors or messages that caused a failure in the application flow\n" @@ -13032,24 +13103,23 @@ ], "source": { "path": "node_modules/@kbn/logging/target/logger.d.ts", - "lineNumber": 48 + "lineNumber": 41 } }, { "id": "def-server.Logger.error.$2", - "type": "Object", + "type": "Uncategorized", "label": "meta", "isRequired": false, "signature": [ - "LogMeta", - " | undefined" + "Meta | undefined" ], "description": [ "-" ], "source": { "path": "node_modules/@kbn/logging/target/logger.d.ts", - "lineNumber": 48 + "lineNumber": 41 } } ], @@ -13057,7 +13127,7 @@ "returnComment": [], "source": { "path": "node_modules/@kbn/logging/target/logger.d.ts", - "lineNumber": 48 + "lineNumber": 41 } }, { @@ -13065,9 +13135,11 @@ "type": "Function", "label": "fatal", "signature": [ - "(errorOrMessage: string | Error, meta?: ", + " void" + " = ", + "LogMeta", + ">(errorOrMessage: string | Error, meta?: Meta | undefined) => void" ], "description": [ "\nLogs abnormal or unexpected errors or messages that caused an unrecoverable failure\n" @@ -13086,24 +13158,23 @@ ], "source": { "path": "node_modules/@kbn/logging/target/logger.d.ts", - "lineNumber": 55 + "lineNumber": 48 } }, { "id": "def-server.Logger.fatal.$2", - "type": "Object", + "type": "Uncategorized", "label": "meta", "isRequired": false, "signature": [ - "LogMeta", - " | undefined" + "Meta | undefined" ], "description": [ "-" ], "source": { "path": "node_modules/@kbn/logging/target/logger.d.ts", - "lineNumber": 55 + "lineNumber": 48 } } ], @@ -13111,7 +13182,7 @@ "returnComment": [], "source": { "path": "node_modules/@kbn/logging/target/logger.d.ts", - "lineNumber": 55 + "lineNumber": 48 } }, { @@ -13137,7 +13208,7 @@ "description": [], "source": { "path": "node_modules/@kbn/logging/target/logger.d.ts", - "lineNumber": 67 + "lineNumber": 60 } } ], @@ -13145,13 +13216,13 @@ "returnComment": [], "source": { "path": "node_modules/@kbn/logging/target/logger.d.ts", - "lineNumber": 67 + "lineNumber": 60 } } ], "source": { "path": "node_modules/@kbn/logging/target/logger.d.ts", - "lineNumber": 16 + "lineNumber": 9 }, "initialIsOpen": false }, @@ -13344,41 +13415,6 @@ }, "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": [], - "source": { - "path": "node_modules/@kbn/logging/target/logger.d.ts", - "lineNumber": 8 - }, - "signature": [ - "any" - ] - } - ], - "source": { - "path": "node_modules/@kbn/logging/target/logger.d.ts", - "lineNumber": 7 - }, - "initialIsOpen": false - }, { "id": "def-server.MetricsServiceSetup", "type": "Interface", @@ -14059,7 +14095,7 @@ "description": [], "source": { "path": "src/core/server/plugins/types.ts", - "lineNumber": 255 + "lineNumber": 288 } }, { @@ -14073,7 +14109,7 @@ "description": [], "source": { "path": "src/core/server/plugins/types.ts", - "lineNumber": 255 + "lineNumber": 288 } } ], @@ -14081,7 +14117,7 @@ "returnComment": [], "source": { "path": "src/core/server/plugins/types.ts", - "lineNumber": 255 + "lineNumber": 288 } }, { @@ -14118,7 +14154,7 @@ "description": [], "source": { "path": "src/core/server/plugins/types.ts", - "lineNumber": 257 + "lineNumber": 290 } }, { @@ -14132,7 +14168,7 @@ "description": [], "source": { "path": "src/core/server/plugins/types.ts", - "lineNumber": 257 + "lineNumber": 290 } } ], @@ -14140,7 +14176,7 @@ "returnComment": [], "source": { "path": "src/core/server/plugins/types.ts", - "lineNumber": 257 + "lineNumber": 290 } }, { @@ -14156,13 +14192,13 @@ "returnComment": [], "source": { "path": "src/core/server/plugins/types.ts", - "lineNumber": 259 + "lineNumber": 292 } } ], "source": { "path": "src/core/server/plugins/types.ts", - "lineNumber": 249 + "lineNumber": 282 }, "initialIsOpen": false }, @@ -14197,7 +14233,7 @@ ], "source": { "path": "src/core/server/plugins/types.ts", - "lineNumber": 62 + "lineNumber": 64 }, "signature": [ "ConfigDeprecationProvider", @@ -14214,7 +14250,7 @@ ], "source": { "path": "src/core/server/plugins/types.ts", - "lineNumber": 66 + "lineNumber": 68 }, "signature": [ "{ [P in keyof T]?: boolean | undefined; } | undefined" @@ -14230,7 +14266,7 @@ ], "source": { "path": "src/core/server/plugins/types.ts", - "lineNumber": 72 + "lineNumber": 74 }, "signature": [ { @@ -14242,11 +14278,34 @@ }, "" ] + }, + { + "tags": [], + "id": "def-server.PluginConfigDescriptor.exposeToUsage", + "type": "Object", + "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}" + ], + "source": { + "path": "src/core/server/plugins/types.ts", + "lineNumber": 85 + }, + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.MakeUsageFromSchema", + "text": "MakeUsageFromSchema" + }, + " | undefined" + ] } ], "source": { "path": "src/core/server/plugins/types.ts", - "lineNumber": 58 + "lineNumber": 60 }, "initialIsOpen": false }, @@ -14279,7 +14338,7 @@ "description": [], "source": { "path": "src/core/server/plugins/types.ts", - "lineNumber": 305 + "lineNumber": 338 }, "signature": [ "symbol" @@ -14293,7 +14352,7 @@ "description": [], "source": { "path": "src/core/server/plugins/types.ts", - "lineNumber": 306 + "lineNumber": 339 }, "signature": [ "{ mode: ", @@ -14313,7 +14372,7 @@ ], "source": { "path": "src/core/server/plugins/types.ts", - "lineNumber": 329 + "lineNumber": 362 }, "signature": [ "LoggerFactory" @@ -14329,7 +14388,7 @@ ], "source": { "path": "src/core/server/plugins/types.ts", - "lineNumber": 333 + "lineNumber": 366 }, "signature": [ "{ legacy: { globalConfig$: ", @@ -14347,7 +14406,7 @@ ], "source": { "path": "src/core/server/plugins/types.ts", - "lineNumber": 304 + "lineNumber": 337 }, "initialIsOpen": false }, @@ -14372,7 +14431,7 @@ ], "source": { "path": "src/core/server/plugins/types.ts", - "lineNumber": 107 + "lineNumber": 140 } }, { @@ -14385,7 +14444,7 @@ ], "source": { "path": "src/core/server/plugins/types.ts", - "lineNumber": 112 + "lineNumber": 145 } }, { @@ -14398,7 +14457,7 @@ ], "source": { "path": "src/core/server/plugins/types.ts", - "lineNumber": 117 + "lineNumber": 150 } }, { @@ -14411,7 +14470,7 @@ ], "source": { "path": "src/core/server/plugins/types.ts", - "lineNumber": 127 + "lineNumber": 160 }, "signature": [ "string | string[]" @@ -14427,7 +14486,7 @@ ], "source": { "path": "src/core/server/plugins/types.ts", - "lineNumber": 133 + "lineNumber": 166 }, "signature": [ "readonly string[]" @@ -14443,7 +14502,7 @@ ], "source": { "path": "src/core/server/plugins/types.ts", - "lineNumber": 145 + "lineNumber": 178 }, "signature": [ "readonly string[]" @@ -14459,7 +14518,7 @@ ], "source": { "path": "src/core/server/plugins/types.ts", - "lineNumber": 152 + "lineNumber": 185 }, "signature": [ "readonly string[]" @@ -14475,7 +14534,7 @@ ], "source": { "path": "src/core/server/plugins/types.ts", - "lineNumber": 158 + "lineNumber": 191 } }, { @@ -14488,7 +14547,7 @@ ], "source": { "path": "src/core/server/plugins/types.ts", - "lineNumber": 163 + "lineNumber": 196 } }, { @@ -14503,7 +14562,7 @@ ], "source": { "path": "src/core/server/plugins/types.ts", - "lineNumber": 171 + "lineNumber": 204 }, "signature": [ "string[] | undefined" @@ -14519,7 +14578,7 @@ ], "source": { "path": "src/core/server/plugins/types.ts", - "lineNumber": 177 + "lineNumber": 210 }, "signature": [ "readonly string[] | undefined" @@ -14528,7 +14587,7 @@ ], "source": { "path": "src/core/server/plugins/types.ts", - "lineNumber": 102 + "lineNumber": 135 }, "initialIsOpen": false }, @@ -14595,7 +14654,7 @@ "description": [], "source": { "path": "src/core/server/index.ts", - "lineNumber": 432 + "lineNumber": 440 }, "signature": [ "{ savedObjects: { client: Pick<", @@ -14643,7 +14702,7 @@ ], "source": { "path": "src/core/server/index.ts", - "lineNumber": 431 + "lineNumber": 439 }, "initialIsOpen": false }, @@ -16078,6 +16137,25 @@ ], "initialIsOpen": false }, + { + "tags": [ + "public" + ], + "id": "def-server.APP_WRAPPER_CLASS", + "type": "string", + "label": "APP_WRAPPER_CLASS", + "description": [ + "\nThe class name for top level *and* nested application wrappers to ensure proper layout" + ], + "source": { + "path": "src/core/utils/app_wrapper_class.ts", + "lineNumber": 13 + }, + "signature": [ + "\"kbnAppWrapper\"" + ], + "initialIsOpen": false + }, { "id": "def-server.AppenderConfigType", "type": "Type", @@ -16218,6 +16296,93 @@ ], "initialIsOpen": false }, + { + "id": "def-server.Ecs", + "type": "Type", + "label": "Ecs", + "tags": [ + "public" + ], + "description": [ + "\nRepresents the full ECS schema.\n" + ], + "source": { + "path": "node_modules/@kbn/logging/target/ecs/index.d.ts", + "lineNumber": 50 + }, + "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; }" + ], + "initialIsOpen": false + }, + { + "id": "def-server.EcsEventCategory", + "type": "Type", + "label": "EcsEventCategory", + "tags": [ + "public" + ], + "description": [], + "source": { + "path": "node_modules/@kbn/logging/target/ecs/event.d.ts", + "lineNumber": 36 + }, + "signature": [ + "\"host\" | \"authentication\" | \"database\" | \"package\" | \"session\" | \"network\" | \"file\" | \"process\" | \"registry\" | \"web\" | \"configuration\" | \"driver\" | \"iam\" | \"intrusion_detection\" | \"malware\"" + ], + "initialIsOpen": false + }, + { + "id": "def-server.EcsEventKind", + "type": "Type", + "label": "EcsEventKind", + "tags": [ + "public" + ], + "description": [], + "source": { + "path": "node_modules/@kbn/logging/target/ecs/event.d.ts", + "lineNumber": 40 + }, + "signature": [ + "\"alert\" | \"event\" | \"state\" | \"metric\" | \"signal\" | \"pipeline_error\"" + ], + "initialIsOpen": false + }, + { + "id": "def-server.EcsEventOutcome", + "type": "Type", + "label": "EcsEventOutcome", + "tags": [ + "public" + ], + "description": [], + "source": { + "path": "node_modules/@kbn/logging/target/ecs/event.d.ts", + "lineNumber": 44 + }, + "signature": [ + "\"success\" | \"failure\" | \"unknown\"" + ], + "initialIsOpen": false + }, + { + "id": "def-server.EcsEventType", + "type": "Type", + "label": "EcsEventType", + "tags": [ + "public" + ], + "description": [], + "source": { + "path": "node_modules/@kbn/logging/target/ecs/event.d.ts", + "lineNumber": 48 + }, + "signature": [ + "\"start\" | \"connection\" | \"end\" | \"user\" | \"info\" | \"error\" | \"group\" | \"protocol\" | \"access\" | \"admin\" | \"allowed\" | \"change\" | \"creation\" | \"deletion\" | \"denied\" | \"installation\"" + ], + "initialIsOpen": false + }, { "id": "def-server.ElasticsearchClient", "type": "Type", @@ -16571,6 +16736,44 @@ ], "initialIsOpen": false }, + { + "id": "def-server.LogMeta", + "type": "Type", + "label": "LogMeta", + "tags": [ + "public" + ], + "description": [ + "\nRepresents the ECS schema with the following reserved keys excluded:\n- `ecs`\n- `@timestamp`\n- `message`\n- `log.level`\n- `log.logger`\n" + ], + "source": { + "path": "node_modules/@kbn/logging/target/log_meta.d.ts", + "lineNumber": 44 + }, + "signature": [ + "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; }" + ], + "initialIsOpen": false + }, + { + "id": "def-server.MakeUsageFromSchema", + "type": "Type", + "label": "MakeUsageFromSchema", + "tags": [ + "public" + ], + "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" + ], + "source": { + "path": "src/core/server/plugins/types.ts", + "lineNumber": 97 + }, + "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; }" + ], + "initialIsOpen": false + }, { "id": "def-server.MetricsServiceStart", "type": "Type", @@ -16638,7 +16841,7 @@ ], "source": { "path": "src/core/server/plugins/types.ts", - "lineNumber": 26 + "lineNumber": 28 }, "signature": [ "Type" @@ -16657,7 +16860,7 @@ ], "source": { "path": "src/core/server/plugins/types.ts", - "lineNumber": 411 + "lineNumber": 444 }, "signature": [ "(core: ", @@ -16700,7 +16903,7 @@ ], "source": { "path": "src/core/server/plugins/types.ts", - "lineNumber": 81 + "lineNumber": 114 }, "signature": [ "string" @@ -16717,7 +16920,7 @@ "description": [], "source": { "path": "src/core/server/plugins/types.ts", - "lineNumber": 84 + "lineNumber": 117 }, "signature": [ "symbol" @@ -16856,7 +17059,7 @@ "description": [], "source": { "path": "src/core/server/plugins/types.ts", - "lineNumber": 292 + "lineNumber": 325 }, "signature": [ "{ readonly kibana: Readonly<{ readonly index: string; readonly autocompleteTerminateAfter: Readonly<{ clone: () => ", @@ -16884,7 +17087,7 @@ ], "source": { "path": "src/core/server/index.ts", - "lineNumber": 502 + "lineNumber": 510 }, "signature": [ "() => Promise<[", diff --git a/api_docs/core_application.json b/api_docs/core_application.json index 0c9ae36b4cc96..96c2319997e8c 100644 --- a/api_docs/core_application.json +++ b/api_docs/core_application.json @@ -1070,7 +1070,7 @@ ], "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; }>; }>" @@ -1086,7 +1086,7 @@ ], "source": { "path": "src/core/public/application/types.ts", - "lineNumber": 704 + "lineNumber": 709 }, "signature": [ "Observable", @@ -1131,7 +1131,7 @@ "description": [], "source": { "path": "src/core/public/application/types.ts", - "lineNumber": 712 + "lineNumber": 717 } }, { @@ -1154,7 +1154,7 @@ ], "source": { "path": "src/core/public/application/types.ts", - "lineNumber": 712 + "lineNumber": 717 } } ], @@ -1162,7 +1162,7 @@ "returnComment": [], "source": { "path": "src/core/public/application/types.ts", - "lineNumber": 712 + "lineNumber": 717 } }, { @@ -1189,7 +1189,7 @@ ], "source": { "path": "src/core/public/application/types.ts", - "lineNumber": 750 + "lineNumber": 755 } } ], @@ -1197,7 +1197,7 @@ "returnComment": [], "source": { "path": "src/core/public/application/types.ts", - "lineNumber": 750 + "lineNumber": 755 } }, { @@ -1222,7 +1222,7 @@ "description": [], "source": { "path": "src/core/public/application/types.ts", - "lineNumber": 764 + "lineNumber": 769 } }, { @@ -1240,7 +1240,7 @@ "description": [], "source": { "path": "src/core/public/application/types.ts", - "lineNumber": 764 + "lineNumber": 769 }, "signature": [ "string | undefined" @@ -1254,7 +1254,7 @@ "description": [], "source": { "path": "src/core/public/application/types.ts", - "lineNumber": 764 + "lineNumber": 769 }, "signature": [ "boolean | undefined" @@ -1263,7 +1263,7 @@ ], "source": { "path": "src/core/public/application/types.ts", - "lineNumber": 764 + "lineNumber": 769 } } ], @@ -1271,7 +1271,7 @@ "returnComment": [], "source": { "path": "src/core/public/application/types.ts", - "lineNumber": 764 + "lineNumber": 769 } }, { @@ -1284,7 +1284,7 @@ ], "source": { "path": "src/core/public/application/types.ts", - "lineNumber": 769 + "lineNumber": 774 }, "signature": [ "Observable", @@ -1294,7 +1294,7 @@ ], "source": { "path": "src/core/public/application/types.ts", - "lineNumber": 691 + "lineNumber": 696 }, "initialIsOpen": false }, @@ -1541,6 +1541,22 @@ "signature": [ "boolean | undefined" ] + }, + { + "tags": [], + "id": "def-public.NavigateToAppOptions.openInNewTab", + "type": "CompoundType", + "label": "openInNewTab", + "description": [ + "\nif true, will open the app in new tab, will share session information via window.open if base" + ], + "source": { + "path": "src/core/public/application/types.ts", + "lineNumber": 692 + }, + "signature": [ + "boolean | undefined" + ] } ], "source": { diff --git a/api_docs/core_chrome.json b/api_docs/core_chrome.json index 8fa999791ee86..b36687dd1aeb3 100644 --- a/api_docs/core_chrome.json +++ b/api_docs/core_chrome.json @@ -2362,7 +2362,7 @@ "lineNumber": 10 }, "signature": [ - "\"legacy\" | \"modern\"" + "\"modern\" | \"legacy\"" ], "initialIsOpen": false } diff --git a/api_docs/core_http.json b/api_docs/core_http.json index c65171153a6fb..1bd972f058277 100644 --- a/api_docs/core_http.json +++ b/api_docs/core_http.json @@ -2990,7 +2990,7 @@ ], "source": { "path": "src/core/server/http/router/response.ts", - "lineNumber": 79 + "lineNumber": 81 }, "signature": [ "T | undefined" @@ -3006,12 +3006,28 @@ ], "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" ] }, + { + "tags": [], + "id": "def-server.CustomHttpResponseOptions.bypassErrorFormat", + "type": "CompoundType", + "label": "bypassErrorFormat", + "description": [ + "Bypass the default error formatting" + ], + "source": { + "path": "src/core/server/http/router/response.ts", + "lineNumber": 85 + }, + "signature": [ + "boolean | undefined" + ] + }, { "tags": [], "id": "def-server.CustomHttpResponseOptions.statusCode", @@ -3020,13 +3036,13 @@ "description": [], "source": { "path": "src/core/server/http/router/response.ts", - "lineNumber": 82 + "lineNumber": 86 } } ], "source": { "path": "src/core/server/http/router/response.ts", - "lineNumber": 77 + "lineNumber": 79 }, "initialIsOpen": false }, @@ -3051,7 +3067,7 @@ ], "source": { "path": "src/core/server/http/router/response.ts", - "lineNumber": 101 + "lineNumber": 105 }, "signature": [ "string | Error | { message: string | Error; attributes?: Record | undefined; } | undefined" @@ -3067,7 +3083,7 @@ ], "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" @@ -3076,7 +3092,7 @@ ], "source": { "path": "src/core/server/http/router/response.ts", - "lineNumber": 99 + "lineNumber": 103 }, "initialIsOpen": false }, @@ -3188,6 +3204,22 @@ "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" ] + }, + { + "tags": [], + "id": "def-server.HttpResponseOptions.bypassErrorFormat", + "type": "CompoundType", + "label": "bypassErrorFormat", + "description": [ + "Bypass the default error formatting" + ], + "source": { + "path": "src/core/server/http/router/response.ts", + "lineNumber": 66 + }, + "signature": [ + "boolean | undefined" + ] } ], "source": { @@ -3217,7 +3249,7 @@ ], "source": { "path": "src/core/server/http/types.ts", - "lineNumber": 336 + "lineNumber": 343 } }, { @@ -3230,7 +3262,7 @@ ], "source": { "path": "src/core/server/http/types.ts", - "lineNumber": 338 + "lineNumber": 345 } }, { @@ -3243,7 +3275,7 @@ ], "source": { "path": "src/core/server/http/types.ts", - "lineNumber": 340 + "lineNumber": 347 } }, { @@ -3256,7 +3288,7 @@ ], "source": { "path": "src/core/server/http/types.ts", - "lineNumber": 342 + "lineNumber": 349 }, "signature": [ "\"http\" | \"https\" | \"socket\"" @@ -3265,7 +3297,7 @@ ], "source": { "path": "src/core/server/http/types.ts", - "lineNumber": 334 + "lineNumber": 341 }, "initialIsOpen": false }, @@ -3634,7 +3666,7 @@ ], "source": { "path": "src/core/server/http/types.ts", - "lineNumber": 308 + "lineNumber": 315 }, "signature": [ "Pick<", @@ -3658,7 +3690,7 @@ ], "source": { "path": "src/core/server/http/types.ts", - "lineNumber": 314 + "lineNumber": 321 }, "signature": [ { @@ -3680,7 +3712,7 @@ ], "source": { "path": "src/core/server/http/types.ts", - "lineNumber": 319 + "lineNumber": 326 }, "signature": [ "() => ", @@ -3696,7 +3728,7 @@ ], "source": { "path": "src/core/server/http/types.ts", - "lineNumber": 303 + "lineNumber": 310 }, "initialIsOpen": false }, @@ -4057,7 +4089,7 @@ ], "source": { "path": "src/core/server/http/router/router.ts", - "lineNumber": 65 + "lineNumber": 66 } }, { @@ -4070,7 +4102,7 @@ ], "source": { "path": "src/core/server/http/router/router.ts", - "lineNumber": 72 + "lineNumber": 73 }, "signature": [ { @@ -4093,7 +4125,7 @@ ], "source": { "path": "src/core/server/http/router/router.ts", - "lineNumber": 79 + "lineNumber": 80 }, "signature": [ { @@ -4116,7 +4148,7 @@ ], "source": { "path": "src/core/server/http/router/router.ts", - "lineNumber": 86 + "lineNumber": 87 }, "signature": [ { @@ -4139,7 +4171,7 @@ ], "source": { "path": "src/core/server/http/router/router.ts", - "lineNumber": 93 + "lineNumber": 94 }, "signature": [ { @@ -4162,7 +4194,7 @@ ], "source": { "path": "src/core/server/http/router/router.ts", - "lineNumber": 100 + "lineNumber": 101 }, "signature": [ { @@ -4185,7 +4217,7 @@ ], "source": { "path": "src/core/server/http/router/router.ts", - "lineNumber": 106 + "lineNumber": 107 }, "signature": [ { @@ -4200,7 +4232,7 @@ ], "source": { "path": "src/core/server/http/router/router.ts", - "lineNumber": 61 + "lineNumber": 62 }, "initialIsOpen": false }, @@ -4906,7 +4938,7 @@ "type": "number", "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`." ], "source": { "path": "src/core/server/http/router/route.ts", @@ -5743,7 +5775,7 @@ ], "source": { "path": "src/core/server/http/router/response.ts", - "lineNumber": 71 + "lineNumber": 73 }, "signature": [ "undefined | string | Record | Buffer | ", @@ -5844,7 +5876,7 @@ ], "source": { "path": "src/core/server/http/router/response.ts", - "lineNumber": 319 + "lineNumber": 323 }, "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; }" @@ -5882,7 +5914,7 @@ ], "source": { "path": "src/core/server/http/router/response.ts", - "lineNumber": 325 + "lineNumber": 329 }, "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>; }" @@ -6100,7 +6132,7 @@ ], "source": { "path": "src/core/server/http/router/response.ts", - "lineNumber": 89 + "lineNumber": 93 }, "signature": [ "HttpResponseOptions & { headers: { location: string;}; }" @@ -6119,7 +6151,7 @@ ], "source": { "path": "src/core/server/http/router/router.ts", - "lineNumber": 350 + "lineNumber": 351 }, "signature": [ "(context: Context, request: ", @@ -6227,7 +6259,7 @@ ], "source": { "path": "src/core/server/http/router/router.ts", - "lineNumber": 376 + "lineNumber": 377 }, "signature": [ "(handler: ", @@ -6357,7 +6389,7 @@ ], "source": { "path": "src/core/server/http/router/router.ts", - "lineNumber": 47 + "lineNumber": 48 }, "signature": [ "(route: ", @@ -6511,7 +6543,7 @@ "description": [], "source": { "path": "src/core/server/http/router/response.ts", - "lineNumber": 290 + "lineNumber": 294 }, "signature": [ "any" @@ -6525,7 +6557,7 @@ "description": [], "source": { "path": "src/core/server/http/router/response.ts", - "lineNumber": 291 + "lineNumber": 295 }, "signature": [ "any" @@ -6539,7 +6571,7 @@ "description": [], "source": { "path": "src/core/server/http/router/response.ts", - "lineNumber": 292 + "lineNumber": 296 }, "signature": [ "any" @@ -6567,7 +6599,7 @@ "description": [], "source": { "path": "src/core/server/http/router/response.ts", - "lineNumber": 298 + "lineNumber": 302 } } ], @@ -6592,7 +6624,7 @@ "label": "custom", "source": { "path": "src/core/server/http/router/response.ts", - "lineNumber": 297 + "lineNumber": 301 }, "tags": [], "returnComment": [] @@ -6604,7 +6636,7 @@ "label": "kibanaResponseFactory", "source": { "path": "src/core/server/http/router/response.ts", - "lineNumber": 289 + "lineNumber": 293 }, "initialIsOpen": false }, diff --git a/api_docs/core_saved_objects.json b/api_docs/core_saved_objects.json index 693916de32d3a..3d83baae0b722 100644 --- a/api_docs/core_saved_objects.json +++ b/api_docs/core_saved_objects.json @@ -28,7 +28,7 @@ "description": [], "source": { "path": "src/core/public/saved_objects/saved_objects_client.ts", - "lineNumber": 221 + "lineNumber": 222 } }, { @@ -42,7 +42,7 @@ "description": [], "source": { "path": "src/core/public/saved_objects/saved_objects_client.ts", - "lineNumber": 222 + "lineNumber": 223 } }, { @@ -62,7 +62,7 @@ "description": [], "source": { "path": "src/core/public/saved_objects/saved_objects_client.ts", - "lineNumber": 223 + "lineNumber": 224 } } ], @@ -91,7 +91,7 @@ "label": "create", "source": { "path": "src/core/public/saved_objects/saved_objects_client.ts", - "lineNumber": 220 + "lineNumber": 221 }, "tags": [], "returnComment": [] @@ -118,7 +118,7 @@ "description": [], "source": { "path": "src/core/public/saved_objects/saved_objects_client.ts", - "lineNumber": 256 + "lineNumber": 257 } }, { @@ -138,7 +138,7 @@ "description": [], "source": { "path": "src/core/public/saved_objects/saved_objects_client.ts", - "lineNumber": 257 + "lineNumber": 258 } } ], @@ -175,7 +175,7 @@ "label": "bulkCreate", "source": { "path": "src/core/public/saved_objects/saved_objects_client.ts", - "lineNumber": 255 + "lineNumber": 256 }, "tags": [ "property" @@ -199,7 +199,7 @@ "description": [], "source": { "path": "src/core/public/saved_objects/saved_objects_client.ts", - "lineNumber": 284 + "lineNumber": 285 } }, { @@ -213,7 +213,7 @@ "description": [], "source": { "path": "src/core/public/saved_objects/saved_objects_client.ts", - "lineNumber": 285 + "lineNumber": 286 } }, { @@ -228,7 +228,7 @@ "description": [], "source": { "path": "src/core/public/saved_objects/saved_objects_client.ts", - "lineNumber": 286 + "lineNumber": 287 } } ], @@ -243,7 +243,7 @@ "label": "delete", "source": { "path": "src/core/public/saved_objects/saved_objects_client.ts", - "lineNumber": 283 + "lineNumber": 284 }, "tags": [], "returnComment": [] @@ -266,17 +266,17 @@ "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 } } ], "signature": [ - "(options: Pick<", + "(options: Pick<", { "pluginId": "core", "scope": "server", @@ -284,7 +284,7 @@ "section": "def-server.SavedObjectsFindOptions", "text": "SavedObjectsFindOptions" }, - ", \"type\" | \"filter\" | \"fields\" | \"search\" | \"page\" | \"perPage\" | \"sortField\" | \"searchFields\" | \"hasReference\" | \"hasReferenceOperator\" | \"defaultSearchOperator\" | \"namespaces\" | \"preference\">) => Promise<", + ", \"type\" | \"filter\" | \"aggs\" | \"fields\" | \"preference\" | \"page\" | \"perPage\" | \"sortField\" | \"search\" | \"searchFields\" | \"hasReference\" | \"hasReferenceOperator\" | \"defaultSearchOperator\" | \"namespaces\">) => Promise<", { "pluginId": "core", "scope": "public", @@ -292,7 +292,7 @@ "section": "def-public.SavedObjectsFindResponsePublic", "text": "SavedObjectsFindResponsePublic" }, - ">" + ">" ], "description": [ "\nSearch for objects\n" @@ -300,7 +300,7 @@ "label": "find", "source": { "path": "src/core/public/saved_objects/saved_objects_client.ts", - "lineNumber": 313 + "lineNumber": 314 }, "tags": [ "property" @@ -324,7 +324,7 @@ "description": [], "source": { "path": "src/core/public/saved_objects/saved_objects_client.ts", - "lineNumber": 372 + "lineNumber": 381 } }, { @@ -338,7 +338,7 @@ "description": [], "source": { "path": "src/core/public/saved_objects/saved_objects_client.ts", - "lineNumber": 372 + "lineNumber": 381 } } ], @@ -359,7 +359,7 @@ "label": "get", "source": { "path": "src/core/public/saved_objects/saved_objects_client.ts", - "lineNumber": 372 + "lineNumber": 381 }, "tags": [], "returnComment": [ @@ -381,7 +381,7 @@ "description": [], "source": { "path": "src/core/public/saved_objects/saved_objects_client.ts", - "lineNumber": 395 + "lineNumber": 404 } } ], @@ -402,7 +402,7 @@ "label": "bulkGet", "source": { "path": "src/core/public/saved_objects/saved_objects_client.ts", - "lineNumber": 395 + "lineNumber": 404 }, "tags": [], "returnComment": [ @@ -414,7 +414,7 @@ "type": "Function", "label": "update", "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 +422,7 @@ "section": "def-public.SavedObjectsUpdateOptions", "text": "SavedObjectsUpdateOptions" }, - ") => Promise<", + ") => Promise<", { "pluginId": "core", "scope": "public", @@ -447,7 +447,7 @@ "description": [], "source": { "path": "src/core/public/saved_objects/saved_objects_client.ts", - "lineNumber": 427 + "lineNumber": 436 } }, { @@ -461,7 +461,7 @@ "description": [], "source": { "path": "src/core/public/saved_objects/saved_objects_client.ts", - "lineNumber": 428 + "lineNumber": 437 } }, { @@ -475,13 +475,13 @@ "description": [], "source": { "path": "src/core/public/saved_objects/saved_objects_client.ts", - "lineNumber": 429 + "lineNumber": 438 } }, { "id": "def-public.SavedObjectsClient.update.$4", "type": "Object", - "label": "{ version, migrationVersion, references }", + "label": "{ version, references, upsert }", "isRequired": true, "signature": [ { @@ -490,12 +490,13 @@ "docId": "kibCoreSavedObjectsPluginApi", "section": "def-public.SavedObjectsUpdateOptions", "text": "SavedObjectsUpdateOptions" - } + }, + "" ], "description": [], "source": { "path": "src/core/public/saved_objects/saved_objects_client.ts", - "lineNumber": 430 + "lineNumber": 439 } } ], @@ -505,7 +506,7 @@ "returnComment": [], "source": { "path": "src/core/public/saved_objects/saved_objects_client.ts", - "lineNumber": 426 + "lineNumber": 435 } }, { @@ -555,7 +556,7 @@ ], "source": { "path": "src/core/public/saved_objects/saved_objects_client.ts", - "lineNumber": 458 + "lineNumber": 467 } } ], @@ -565,13 +566,13 @@ ], "source": { "path": "src/core/public/saved_objects/saved_objects_client.ts", - "lineNumber": 458 + "lineNumber": 467 } } ], "source": { "path": "src/core/public/saved_objects/saved_objects_client.ts", - "lineNumber": 165 + "lineNumber": 166 }, "initialIsOpen": false }, @@ -903,7 +904,7 @@ "returnComment": [], "source": { "path": "src/core/public/saved_objects/simple_saved_object.ts", - "lineNumber": 86 + "lineNumber": 85 } } ], @@ -943,7 +944,7 @@ "description": [], "source": { "path": "src/core/public/saved_objects/saved_objects_client.ts", - "lineNumber": 89 + "lineNumber": 88 }, "signature": [ { @@ -959,7 +960,7 @@ ], "source": { "path": "src/core/public/saved_objects/saved_objects_client.ts", - "lineNumber": 88 + "lineNumber": 87 }, "initialIsOpen": false }, @@ -1282,7 +1283,7 @@ "section": "def-public.SavedObjectsFindResponsePublic", "text": "SavedObjectsFindResponsePublic" }, - " extends ", + " extends ", { "pluginId": "core", "scope": "public", @@ -1299,6 +1300,20 @@ "public" ], "children": [ + { + "tags": [], + "id": "def-public.SavedObjectsFindResponsePublic.aggregations", + "type": "Uncategorized", + "label": "aggregations", + "description": [], + "source": { + "path": "src/core/public/saved_objects/saved_objects_client.ts", + "lineNumber": 107 + }, + "signature": [ + "A | undefined" + ] + }, { "tags": [], "id": "def-public.SavedObjectsFindResponsePublic.total", @@ -1307,7 +1322,7 @@ "description": [], "source": { "path": "src/core/public/saved_objects/saved_objects_client.ts", - "lineNumber": 107 + "lineNumber": 108 } }, { @@ -1318,7 +1333,7 @@ "description": [], "source": { "path": "src/core/public/saved_objects/saved_objects_client.ts", - "lineNumber": 108 + "lineNumber": 109 } }, { @@ -1329,13 +1344,13 @@ "description": [], "source": { "path": "src/core/public/saved_objects/saved_objects_client.ts", - "lineNumber": 109 + "lineNumber": 110 } } ], "source": { "path": "src/core/public/saved_objects/saved_objects_client.ts", - "lineNumber": 106 + "lineNumber": 105 }, "initialIsOpen": false }, @@ -1383,6 +1398,16 @@ "id": "def-public.SavedObjectsUpdateOptions", "type": "Interface", "label": "SavedObjectsUpdateOptions", + "signature": [ + { + "pluginId": "core", + "scope": "public", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-public.SavedObjectsUpdateOptions", + "text": "SavedObjectsUpdateOptions" + }, + "" + ], "description": [], "tags": [ "public" @@ -1404,19 +1429,16 @@ }, { "tags": [], - "id": "def-public.SavedObjectsUpdateOptions.migrationVersion", - "type": "Object", - "label": "migrationVersion", - "description": [ - "{@inheritDoc SavedObjectsMigrationVersion}" - ], + "id": "def-public.SavedObjectsUpdateOptions.upsert", + "type": "Uncategorized", + "label": "upsert", + "description": [], "source": { "path": "src/core/public/saved_objects/saved_objects_client.ts", - "lineNumber": 83 + "lineNumber": 82 }, "signature": [ - "SavedObjectsMigrationVersion", - " | undefined" + "Attributes | undefined" ] }, { @@ -1427,7 +1449,7 @@ "description": [], "source": { "path": "src/core/public/saved_objects/saved_objects_client.ts", - "lineNumber": 84 + "lineNumber": 83 }, "signature": [ "SavedObjectReference", @@ -1456,10 +1478,10 @@ ], "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>; }" + "{ 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>; }" ], "initialIsOpen": false } @@ -1487,7 +1509,7 @@ "description": [], "source": { "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "lineNumber": 402 + "lineNumber": 405 }, "signature": [ "typeof ", @@ -1508,7 +1530,7 @@ "description": [], "source": { "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "lineNumber": 403 + "lineNumber": 406 }, "signature": [ "typeof ", @@ -1553,7 +1575,7 @@ "description": [], "source": { "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "lineNumber": 419 + "lineNumber": 422 } }, { @@ -1567,7 +1589,7 @@ "description": [], "source": { "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "lineNumber": 419 + "lineNumber": 422 } }, { @@ -1588,7 +1610,7 @@ "description": [], "source": { "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "lineNumber": 419 + "lineNumber": 422 } } ], @@ -1596,7 +1618,7 @@ "returnComment": [], "source": { "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "lineNumber": 419 + "lineNumber": 422 } }, { @@ -1652,7 +1674,7 @@ "description": [], "source": { "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "lineNumber": 430 + "lineNumber": 433 } }, { @@ -1673,7 +1695,7 @@ "description": [], "source": { "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "lineNumber": 431 + "lineNumber": 434 } } ], @@ -1681,7 +1703,7 @@ "returnComment": [], "source": { "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "lineNumber": 429 + "lineNumber": 432 } }, { @@ -1737,7 +1759,7 @@ "description": [], "source": { "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "lineNumber": 444 + "lineNumber": 447 } }, { @@ -1757,7 +1779,7 @@ "description": [], "source": { "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "lineNumber": 445 + "lineNumber": 448 } } ], @@ -1765,7 +1787,7 @@ "returnComment": [], "source": { "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "lineNumber": 443 + "lineNumber": 446 } }, { @@ -1798,7 +1820,7 @@ "description": [], "source": { "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "lineNumber": 457 + "lineNumber": 460 } }, { @@ -1812,7 +1834,7 @@ "description": [], "source": { "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "lineNumber": 457 + "lineNumber": 460 } }, { @@ -1832,7 +1854,7 @@ "description": [], "source": { "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "lineNumber": 457 + "lineNumber": 460 } } ], @@ -1840,7 +1862,7 @@ "returnComment": [], "source": { "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "lineNumber": 457 + "lineNumber": 460 } }, { @@ -1848,7 +1870,7 @@ "type": "Function", "label": "find", "signature": [ - "(options: ", + "(options: ", { "pluginId": "core", "scope": "server", @@ -1864,7 +1886,7 @@ "section": "def-server.SavedObjectsFindResponse", "text": "SavedObjectsFindResponse" }, - ">" + ">" ], "description": [ "\nFind all SavedObjects matching the search query\n" @@ -1887,7 +1909,7 @@ "description": [], "source": { "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "lineNumber": 466 + "lineNumber": 470 } } ], @@ -1895,7 +1917,7 @@ "returnComment": [], "source": { "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "lineNumber": 466 + "lineNumber": 469 } }, { @@ -1953,7 +1975,7 @@ ], "source": { "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "lineNumber": 482 + "lineNumber": 487 } }, { @@ -1973,7 +1995,7 @@ "description": [], "source": { "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "lineNumber": 483 + "lineNumber": 488 } } ], @@ -1981,7 +2003,7 @@ "returnComment": [], "source": { "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "lineNumber": 481 + "lineNumber": 486 } }, { @@ -2018,7 +2040,7 @@ ], "source": { "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "lineNumber": 496 + "lineNumber": 501 } }, { @@ -2034,7 +2056,7 @@ ], "source": { "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "lineNumber": 497 + "lineNumber": 502 } }, { @@ -2054,7 +2076,7 @@ "description": [], "source": { "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "lineNumber": 498 + "lineNumber": 503 } } ], @@ -2062,7 +2084,7 @@ "returnComment": [], "source": { "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "lineNumber": 495 + "lineNumber": 500 } }, { @@ -2105,7 +2127,7 @@ ], "source": { "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "lineNumber": 511 + "lineNumber": 516 } }, { @@ -2121,7 +2143,7 @@ ], "source": { "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "lineNumber": 512 + "lineNumber": 517 } }, { @@ -2141,7 +2163,7 @@ "description": [], "source": { "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "lineNumber": 513 + "lineNumber": 518 } } ], @@ -2149,7 +2171,7 @@ "returnComment": [], "source": { "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "lineNumber": 510 + "lineNumber": 515 } }, { @@ -2165,7 +2187,7 @@ "section": "def-server.SavedObjectsUpdateOptions", "text": "SavedObjectsUpdateOptions" }, - ") => Promise<", + ") => Promise<", { "pluginId": "core", "scope": "server", @@ -2190,7 +2212,7 @@ "description": [], "source": { "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "lineNumber": 526 + "lineNumber": 531 } }, { @@ -2204,7 +2226,7 @@ "description": [], "source": { "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "lineNumber": 527 + "lineNumber": 532 } }, { @@ -2218,7 +2240,7 @@ "description": [], "source": { "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "lineNumber": 528 + "lineNumber": 533 } }, { @@ -2233,12 +2255,13 @@ "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 } } ], @@ -2246,7 +2269,7 @@ "returnComment": [], "source": { "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "lineNumber": 525 + "lineNumber": 530 } }, { @@ -2287,7 +2310,7 @@ "description": [], "source": { "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "lineNumber": 543 + "lineNumber": 548 } }, { @@ -2301,7 +2324,7 @@ "description": [], "source": { "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "lineNumber": 544 + "lineNumber": 549 } }, { @@ -2315,7 +2338,7 @@ "description": [], "source": { "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "lineNumber": 545 + "lineNumber": 550 } }, { @@ -2335,7 +2358,7 @@ "description": [], "source": { "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "lineNumber": 546 + "lineNumber": 551 } } ], @@ -2343,7 +2366,7 @@ "returnComment": [], "source": { "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "lineNumber": 542 + "lineNumber": 547 } }, { @@ -2384,7 +2407,7 @@ "description": [], "source": { "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "lineNumber": 560 + "lineNumber": 565 } }, { @@ -2398,7 +2421,7 @@ "description": [], "source": { "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "lineNumber": 561 + "lineNumber": 566 } }, { @@ -2412,7 +2435,7 @@ "description": [], "source": { "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "lineNumber": 562 + "lineNumber": 567 } }, { @@ -2432,7 +2455,7 @@ "description": [], "source": { "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "lineNumber": 563 + "lineNumber": 568 } } ], @@ -2440,7 +2463,7 @@ "returnComment": [], "source": { "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "lineNumber": 559 + "lineNumber": 564 } }, { @@ -2496,7 +2519,7 @@ "description": [], "source": { "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "lineNumber": 574 + "lineNumber": 579 } }, { @@ -2517,7 +2540,7 @@ "description": [], "source": { "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "lineNumber": 575 + "lineNumber": 580 } } ], @@ -2525,7 +2548,7 @@ "returnComment": [], "source": { "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "lineNumber": 573 + "lineNumber": 578 } }, { @@ -2566,7 +2589,7 @@ "description": [], "source": { "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "lineNumber": 584 + "lineNumber": 589 } }, { @@ -2580,7 +2603,7 @@ "description": [], "source": { "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "lineNumber": 585 + "lineNumber": 590 } }, { @@ -2601,7 +2624,7 @@ "description": [], "source": { "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "lineNumber": 586 + "lineNumber": 591 } } ], @@ -2609,7 +2632,7 @@ "returnComment": [], "source": { "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "lineNumber": 583 + "lineNumber": 588 } }, { @@ -2650,7 +2673,7 @@ "description": [], "source": { "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "lineNumber": 600 + "lineNumber": 605 } }, { @@ -2670,7 +2693,7 @@ "description": [], "source": { "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "lineNumber": 601 + "lineNumber": 606 } } ], @@ -2678,7 +2701,7 @@ "returnComment": [], "source": { "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "lineNumber": 599 + "lineNumber": 604 } }, { @@ -2719,7 +2742,7 @@ "description": [], "source": { "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "lineNumber": 614 + "lineNumber": 619 } }, { @@ -2740,7 +2763,7 @@ "description": [], "source": { "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "lineNumber": 614 + "lineNumber": 619 } } ], @@ -2748,7 +2771,7 @@ "returnComment": [], "source": { "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "lineNumber": 614 + "lineNumber": 619 } }, { @@ -2764,7 +2787,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", @@ -2799,12 +2822,12 @@ "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 } }, { @@ -2825,7 +2848,7 @@ "description": [], "source": { "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "lineNumber": 665 + "lineNumber": 670 } } ], @@ -2833,13 +2856,13 @@ "returnComment": [], "source": { "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "lineNumber": 663 + "lineNumber": 668 } } ], "source": { "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "lineNumber": 401 + "lineNumber": 404 }, "initialIsOpen": false }, @@ -5299,7 +5322,7 @@ "description": [], "source": { "path": "src/core/server/saved_objects/service/lib/repository.ts", - "lineNumber": 257 + "lineNumber": 258 } }, { @@ -5313,7 +5336,7 @@ "description": [], "source": { "path": "src/core/server/saved_objects/service/lib/repository.ts", - "lineNumber": 258 + "lineNumber": 259 } }, { @@ -5333,7 +5356,7 @@ "description": [], "source": { "path": "src/core/server/saved_objects/service/lib/repository.ts", - "lineNumber": 259 + "lineNumber": 260 } } ], @@ -5345,7 +5368,7 @@ ], "source": { "path": "src/core/server/saved_objects/service/lib/repository.ts", - "lineNumber": 256 + "lineNumber": 257 } }, { @@ -5403,7 +5426,7 @@ ], "source": { "path": "src/core/server/saved_objects/service/lib/repository.ts", - "lineNumber": 350 + "lineNumber": 351 } }, { @@ -5423,7 +5446,7 @@ "description": [], "source": { "path": "src/core/server/saved_objects/service/lib/repository.ts", - "lineNumber": 351 + "lineNumber": 352 } } ], @@ -5435,7 +5458,7 @@ ], "source": { "path": "src/core/server/saved_objects/service/lib/repository.ts", - "lineNumber": 349 + "lineNumber": 350 } }, { @@ -5491,7 +5514,7 @@ "description": [], "source": { "path": "src/core/server/saved_objects/service/lib/repository.ts", - "lineNumber": 541 + "lineNumber": 542 } }, { @@ -5511,7 +5534,7 @@ "description": [], "source": { "path": "src/core/server/saved_objects/service/lib/repository.ts", - "lineNumber": 542 + "lineNumber": 543 } } ], @@ -5519,7 +5542,7 @@ "returnComment": [], "source": { "path": "src/core/server/saved_objects/service/lib/repository.ts", - "lineNumber": 540 + "lineNumber": 541 } }, { @@ -5552,7 +5575,7 @@ "description": [], "source": { "path": "src/core/server/saved_objects/service/lib/repository.ts", - "lineNumber": 627 + "lineNumber": 628 } }, { @@ -5566,7 +5589,7 @@ "description": [], "source": { "path": "src/core/server/saved_objects/service/lib/repository.ts", - "lineNumber": 627 + "lineNumber": 628 } }, { @@ -5586,7 +5609,7 @@ "description": [], "source": { "path": "src/core/server/saved_objects/service/lib/repository.ts", - "lineNumber": 627 + "lineNumber": 628 } } ], @@ -5596,7 +5619,7 @@ "returnComment": [], "source": { "path": "src/core/server/saved_objects/service/lib/repository.ts", - "lineNumber": 627 + "lineNumber": 628 } }, { @@ -5629,7 +5652,7 @@ "description": [], "source": { "path": "src/core/server/saved_objects/service/lib/repository.ts", - "lineNumber": 690 + "lineNumber": 691 } }, { @@ -5649,7 +5672,7 @@ "description": [], "source": { "path": "src/core/server/saved_objects/service/lib/repository.ts", - "lineNumber": 691 + "lineNumber": 692 } } ], @@ -5659,7 +5682,7 @@ ], "source": { "path": "src/core/server/saved_objects/service/lib/repository.ts", - "lineNumber": 689 + "lineNumber": 690 } }, { @@ -5667,7 +5690,7 @@ "type": "Function", "label": "find", "signature": [ - "(options: ", + "(options: ", { "pluginId": "core", "scope": "server", @@ -5683,7 +5706,7 @@ "section": "def-server.SavedObjectsFindResponse", "text": "SavedObjectsFindResponse" }, - ">" + ">" ], "description": [], "children": [ @@ -5704,7 +5727,7 @@ "description": [], "source": { "path": "src/core/server/saved_objects/service/lib/repository.ts", - "lineNumber": 751 + "lineNumber": 753 } } ], @@ -5716,7 +5739,7 @@ ], "source": { "path": "src/core/server/saved_objects/service/lib/repository.ts", - "lineNumber": 751 + "lineNumber": 752 } }, { @@ -5774,7 +5797,7 @@ ], "source": { "path": "src/core/server/saved_objects/service/lib/repository.ts", - "lineNumber": 906 + "lineNumber": 920 } }, { @@ -5794,7 +5817,7 @@ "description": [], "source": { "path": "src/core/server/saved_objects/service/lib/repository.ts", - "lineNumber": 907 + "lineNumber": 921 } } ], @@ -5806,7 +5829,7 @@ ], "source": { "path": "src/core/server/saved_objects/service/lib/repository.ts", - "lineNumber": 905 + "lineNumber": 919 } }, { @@ -5841,7 +5864,7 @@ "description": [], "source": { "path": "src/core/server/saved_objects/service/lib/repository.ts", - "lineNumber": 993 + "lineNumber": 1007 } }, { @@ -5855,7 +5878,7 @@ "description": [], "source": { "path": "src/core/server/saved_objects/service/lib/repository.ts", - "lineNumber": 994 + "lineNumber": 1008 } }, { @@ -5875,7 +5898,7 @@ "description": [], "source": { "path": "src/core/server/saved_objects/service/lib/repository.ts", - "lineNumber": 995 + "lineNumber": 1009 } } ], @@ -5887,7 +5910,7 @@ ], "source": { "path": "src/core/server/saved_objects/service/lib/repository.ts", - "lineNumber": 992 + "lineNumber": 1006 } }, { @@ -5928,7 +5951,7 @@ "description": [], "source": { "path": "src/core/server/saved_objects/service/lib/repository.ts", - "lineNumber": 1035 + "lineNumber": 1049 } }, { @@ -5942,7 +5965,7 @@ "description": [], "source": { "path": "src/core/server/saved_objects/service/lib/repository.ts", - "lineNumber": 1036 + "lineNumber": 1050 } }, { @@ -5962,7 +5985,7 @@ "description": [], "source": { "path": "src/core/server/saved_objects/service/lib/repository.ts", - "lineNumber": 1037 + "lineNumber": 1051 } } ], @@ -5974,7 +5997,7 @@ ], "source": { "path": "src/core/server/saved_objects/service/lib/repository.ts", - "lineNumber": 1034 + "lineNumber": 1048 } }, { @@ -5990,7 +6013,7 @@ "section": "def-server.SavedObjectsUpdateOptions", "text": "SavedObjectsUpdateOptions" }, - ") => Promise<", + ") => Promise<", { "pluginId": "core", "scope": "server", @@ -6015,7 +6038,7 @@ "description": [], "source": { "path": "src/core/server/saved_objects/service/lib/repository.ts", - "lineNumber": 1160 + "lineNumber": 1174 } }, { @@ -6029,7 +6052,7 @@ "description": [], "source": { "path": "src/core/server/saved_objects/service/lib/repository.ts", - "lineNumber": 1161 + "lineNumber": 1175 } }, { @@ -6043,7 +6066,7 @@ "description": [], "source": { "path": "src/core/server/saved_objects/service/lib/repository.ts", - "lineNumber": 1162 + "lineNumber": 1176 } }, { @@ -6058,12 +6081,13 @@ "docId": "kibCoreSavedObjectsPluginApi", "section": "def-server.SavedObjectsUpdateOptions", "text": "SavedObjectsUpdateOptions" - } + }, + "" ], "description": [], "source": { "path": "src/core/server/saved_objects/service/lib/repository.ts", - "lineNumber": 1163 + "lineNumber": 1177 } } ], @@ -6073,7 +6097,7 @@ "returnComment": [], "source": { "path": "src/core/server/saved_objects/service/lib/repository.ts", - "lineNumber": 1159 + "lineNumber": 1173 } }, { @@ -6114,7 +6138,7 @@ "description": [], "source": { "path": "src/core/server/saved_objects/service/lib/repository.ts", - "lineNumber": 1232 + "lineNumber": 1271 } }, { @@ -6128,7 +6152,7 @@ "description": [], "source": { "path": "src/core/server/saved_objects/service/lib/repository.ts", - "lineNumber": 1233 + "lineNumber": 1272 } }, { @@ -6142,7 +6166,7 @@ "description": [], "source": { "path": "src/core/server/saved_objects/service/lib/repository.ts", - "lineNumber": 1234 + "lineNumber": 1273 } }, { @@ -6162,7 +6186,7 @@ "description": [], "source": { "path": "src/core/server/saved_objects/service/lib/repository.ts", - "lineNumber": 1235 + "lineNumber": 1274 } } ], @@ -6170,7 +6194,7 @@ "returnComment": [], "source": { "path": "src/core/server/saved_objects/service/lib/repository.ts", - "lineNumber": 1231 + "lineNumber": 1270 } }, { @@ -6211,7 +6235,7 @@ "description": [], "source": { "path": "src/core/server/saved_objects/service/lib/repository.ts", - "lineNumber": 1295 + "lineNumber": 1334 } }, { @@ -6225,7 +6249,7 @@ "description": [], "source": { "path": "src/core/server/saved_objects/service/lib/repository.ts", - "lineNumber": 1296 + "lineNumber": 1335 } }, { @@ -6239,7 +6263,7 @@ "description": [], "source": { "path": "src/core/server/saved_objects/service/lib/repository.ts", - "lineNumber": 1297 + "lineNumber": 1336 } }, { @@ -6259,7 +6283,7 @@ "description": [], "source": { "path": "src/core/server/saved_objects/service/lib/repository.ts", - "lineNumber": 1298 + "lineNumber": 1337 } } ], @@ -6267,7 +6291,7 @@ "returnComment": [], "source": { "path": "src/core/server/saved_objects/service/lib/repository.ts", - "lineNumber": 1294 + "lineNumber": 1333 } }, { @@ -6325,7 +6349,7 @@ ], "source": { "path": "src/core/server/saved_objects/service/lib/repository.ts", - "lineNumber": 1401 + "lineNumber": 1440 } }, { @@ -6345,7 +6369,7 @@ "description": [], "source": { "path": "src/core/server/saved_objects/service/lib/repository.ts", - "lineNumber": 1402 + "lineNumber": 1441 } } ], @@ -6357,7 +6381,7 @@ ], "source": { "path": "src/core/server/saved_objects/service/lib/repository.ts", - "lineNumber": 1400 + "lineNumber": 1439 } }, { @@ -6398,7 +6422,7 @@ "description": [], "source": { "path": "src/core/server/saved_objects/service/lib/repository.ts", - "lineNumber": 1620 + "lineNumber": 1659 } }, { @@ -6412,7 +6436,7 @@ "description": [], "source": { "path": "src/core/server/saved_objects/service/lib/repository.ts", - "lineNumber": 1621 + "lineNumber": 1660 } }, { @@ -6432,7 +6456,7 @@ "description": [], "source": { "path": "src/core/server/saved_objects/service/lib/repository.ts", - "lineNumber": 1622 + "lineNumber": 1661 } } ], @@ -6440,7 +6464,7 @@ "returnComment": [], "source": { "path": "src/core/server/saved_objects/service/lib/repository.ts", - "lineNumber": 1619 + "lineNumber": 1658 } }, { @@ -6485,7 +6509,7 @@ ], "source": { "path": "src/core/server/saved_objects/service/lib/repository.ts", - "lineNumber": 1731 + "lineNumber": 1770 } }, { @@ -6501,7 +6525,7 @@ ], "source": { "path": "src/core/server/saved_objects/service/lib/repository.ts", - "lineNumber": 1732 + "lineNumber": 1771 } }, { @@ -6525,7 +6549,7 @@ ], "source": { "path": "src/core/server/saved_objects/service/lib/repository.ts", - "lineNumber": 1733 + "lineNumber": 1772 } }, { @@ -6548,7 +6572,7 @@ ], "source": { "path": "src/core/server/saved_objects/service/lib/repository.ts", - "lineNumber": 1734 + "lineNumber": 1773 } } ], @@ -6558,7 +6582,7 @@ ], "source": { "path": "src/core/server/saved_objects/service/lib/repository.ts", - "lineNumber": 1730 + "lineNumber": 1769 } }, { @@ -6599,7 +6623,7 @@ "description": [], "source": { "path": "src/core/server/saved_objects/service/lib/repository.ts", - "lineNumber": 1891 + "lineNumber": 1930 } }, { @@ -6619,7 +6643,7 @@ "description": [], "source": { "path": "src/core/server/saved_objects/service/lib/repository.ts", - "lineNumber": 1892 + "lineNumber": 1931 } } ], @@ -6631,7 +6655,7 @@ ], "source": { "path": "src/core/server/saved_objects/service/lib/repository.ts", - "lineNumber": 1890 + "lineNumber": 1929 } }, { @@ -6672,7 +6696,7 @@ "description": [], "source": { "path": "src/core/server/saved_objects/service/lib/repository.ts", - "lineNumber": 1967 + "lineNumber": 2003 } }, { @@ -6695,7 +6719,7 @@ ], "source": { "path": "src/core/server/saved_objects/service/lib/repository.ts", - "lineNumber": 1968 + "lineNumber": 2004 } } ], @@ -6705,7 +6729,7 @@ ], "source": { "path": "src/core/server/saved_objects/service/lib/repository.ts", - "lineNumber": 1966 + "lineNumber": 2002 } }, { @@ -6721,7 +6745,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", @@ -6756,12 +6780,12 @@ "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 } }, { @@ -6782,7 +6806,7 @@ "description": [], "source": { "path": "src/core/server/saved_objects/service/lib/repository.ts", - "lineNumber": 2024 + "lineNumber": 2060 } } ], @@ -6790,13 +6814,13 @@ "returnComment": [], "source": { "path": "src/core/server/saved_objects/service/lib/repository.ts", - "lineNumber": 2022 + "lineNumber": 2058 } } ], "source": { "path": "src/core/server/saved_objects/service/lib/repository.ts", - "lineNumber": 158 + "lineNumber": 159 }, "initialIsOpen": false }, @@ -6944,7 +6968,7 @@ ], "source": { "path": "src/core/server/saved_objects/serialization/serializer.ts", - "lineNumber": 59 + "lineNumber": 80 } }, { @@ -6966,7 +6990,7 @@ ], "source": { "path": "src/core/server/saved_objects/serialization/serializer.ts", - "lineNumber": 60 + "lineNumber": 81 } } ], @@ -6974,7 +6998,7 @@ "returnComment": [], "source": { "path": "src/core/server/saved_objects/serialization/serializer.ts", - "lineNumber": 58 + "lineNumber": 79 } }, { @@ -7023,7 +7047,7 @@ ], "source": { "path": "src/core/server/saved_objects/serialization/serializer.ts", - "lineNumber": 102 + "lineNumber": 125 } } ], @@ -7031,7 +7055,7 @@ "returnComment": [], "source": { "path": "src/core/server/saved_objects/serialization/serializer.ts", - "lineNumber": 102 + "lineNumber": 125 } }, { @@ -7058,7 +7082,7 @@ ], "source": { "path": "src/core/server/saved_objects/serialization/serializer.ts", - "lineNumber": 143 + "lineNumber": 166 } }, { @@ -7074,7 +7098,7 @@ ], "source": { "path": "src/core/server/saved_objects/serialization/serializer.ts", - "lineNumber": 143 + "lineNumber": 166 } }, { @@ -7090,7 +7114,7 @@ ], "source": { "path": "src/core/server/saved_objects/serialization/serializer.ts", - "lineNumber": 143 + "lineNumber": 166 } } ], @@ -7098,7 +7122,7 @@ "returnComment": [], "source": { "path": "src/core/server/saved_objects/serialization/serializer.ts", - "lineNumber": 143 + "lineNumber": 166 } }, { @@ -7125,7 +7149,7 @@ ], "source": { "path": "src/core/server/saved_objects/serialization/serializer.ts", - "lineNumber": 156 + "lineNumber": 179 } }, { @@ -7141,7 +7165,7 @@ ], "source": { "path": "src/core/server/saved_objects/serialization/serializer.ts", - "lineNumber": 156 + "lineNumber": 179 } }, { @@ -7157,7 +7181,7 @@ ], "source": { "path": "src/core/server/saved_objects/serialization/serializer.ts", - "lineNumber": 156 + "lineNumber": 179 } } ], @@ -7165,7 +7189,7 @@ "returnComment": [], "source": { "path": "src/core/server/saved_objects/serialization/serializer.ts", - "lineNumber": 156 + "lineNumber": 179 } } ], @@ -7276,7 +7300,7 @@ } ], "signature": [ - "({ page, perPage, }: ", + "({ page, perPage, }: ", { "pluginId": "core", "scope": "server", @@ -7292,7 +7316,7 @@ "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." @@ -7831,7 +7855,7 @@ "section": "def-server.SavedObjectsFindResponse", "text": "SavedObjectsFindResponse" }, - ", any, unknown>" + ", any, unknown>" ] }, { @@ -8083,7 +8107,7 @@ ], "source": { "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "lineNumber": 224 + "lineNumber": 227 }, "signature": [ "string | undefined" @@ -8099,7 +8123,7 @@ ], "source": { "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "lineNumber": 226 + "lineNumber": 229 }, "signature": [ "boolean | \"wait_for\" | undefined" @@ -8108,7 +8132,7 @@ ], "source": { "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "lineNumber": 222 + "lineNumber": 225 }, "initialIsOpen": false }, @@ -8133,7 +8157,7 @@ ], "source": { "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "lineNumber": 235 + "lineNumber": 238 }, "signature": [ "string[]" @@ -8142,7 +8166,7 @@ ], "source": { "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "lineNumber": 233 + "lineNumber": 236 }, "initialIsOpen": false }, @@ -8167,7 +8191,7 @@ ], "source": { "path": "src/core/server/saved_objects/types.ts", - "lineNumber": 142 + "lineNumber": 164 }, "signature": [ "string | undefined" @@ -8176,7 +8200,7 @@ ], "source": { "path": "src/core/server/saved_objects/types.ts", - "lineNumber": 140 + "lineNumber": 162 }, "initialIsOpen": false }, @@ -8360,7 +8384,7 @@ "description": [], "source": { "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "lineNumber": 299 + "lineNumber": 302 } }, { @@ -8371,7 +8395,7 @@ "description": [], "source": { "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "lineNumber": 300 + "lineNumber": 303 } }, { @@ -8384,7 +8408,7 @@ ], "source": { "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "lineNumber": 302 + "lineNumber": 305 }, "signature": [ "string[] | undefined" @@ -8393,7 +8417,7 @@ ], "source": { "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "lineNumber": 298 + "lineNumber": 301 }, "initialIsOpen": false }, @@ -8469,7 +8493,7 @@ "description": [], "source": { "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "lineNumber": 310 + "lineNumber": 313 }, "signature": [ "SavedObject", @@ -8479,7 +8503,7 @@ ], "source": { "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "lineNumber": 309 + "lineNumber": 312 }, "initialIsOpen": false }, @@ -8503,7 +8527,7 @@ "section": "def-server.SavedObjectsUpdateOptions", "text": "SavedObjectsUpdateOptions" }, - ", \"version\" | \"references\">" + ", \"version\" | \"references\">" ], "description": [ "\n" @@ -8615,7 +8639,7 @@ ], "source": { "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "lineNumber": 280 + "lineNumber": 283 }, "signature": [ "boolean | \"wait_for\" | undefined" @@ -8624,7 +8648,7 @@ ], "source": { "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "lineNumber": 278 + "lineNumber": 281 }, "initialIsOpen": false }, @@ -8657,7 +8681,7 @@ "description": [], "source": { "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "lineNumber": 318 + "lineNumber": 321 }, "signature": [ { @@ -8673,7 +8697,7 @@ ], "source": { "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "lineNumber": 317 + "lineNumber": 320 }, "initialIsOpen": false }, @@ -8696,7 +8720,7 @@ "description": [], "source": { "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "lineNumber": 189 + "lineNumber": 190 } }, { @@ -8707,13 +8731,13 @@ "description": [], "source": { "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "lineNumber": 190 + "lineNumber": 191 } } ], "source": { "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "lineNumber": 188 + "lineNumber": 189 }, "initialIsOpen": false }, @@ -8736,7 +8760,7 @@ "description": [], "source": { "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "lineNumber": 198 + "lineNumber": 199 }, "signature": [ "{ id: string; type: string; error: ", @@ -8747,7 +8771,7 @@ ], "source": { "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "lineNumber": 197 + "lineNumber": 198 }, "initialIsOpen": false }, @@ -8899,7 +8923,7 @@ ], "source": { "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "lineNumber": 390 + "lineNumber": 393 } }, { @@ -8912,13 +8936,13 @@ ], "source": { "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "lineNumber": 394 + "lineNumber": 397 } } ], "source": { "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "lineNumber": 385 + "lineNumber": 388 }, "initialIsOpen": false }, @@ -9358,7 +9382,7 @@ ], "source": { "path": "src/core/server/saved_objects/service/lib/repository.ts", - "lineNumber": 133 + "lineNumber": 134 }, "signature": [ "boolean | undefined" @@ -9367,7 +9391,7 @@ ], "source": { "path": "src/core/server/saved_objects/service/lib/repository.ts", - "lineNumber": 131 + "lineNumber": 132 }, "initialIsOpen": false }, @@ -9409,7 +9433,7 @@ ], "source": { "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "lineNumber": 244 + "lineNumber": 247 }, "signature": [ "boolean | \"wait_for\" | undefined" @@ -9418,7 +9442,7 @@ ], "source": { "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "lineNumber": 242 + "lineNumber": 245 }, "initialIsOpen": false }, @@ -9443,7 +9467,7 @@ ], "source": { "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "lineNumber": 253 + "lineNumber": 256 }, "signature": [ "string[]" @@ -9452,7 +9476,7 @@ ], "source": { "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "lineNumber": 251 + "lineNumber": 254 }, "initialIsOpen": false }, @@ -9494,7 +9518,7 @@ ], "source": { "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "lineNumber": 289 + "lineNumber": 292 }, "signature": [ "boolean | \"wait_for\" | undefined" @@ -9510,7 +9534,7 @@ ], "source": { "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "lineNumber": 291 + "lineNumber": 294 }, "signature": [ "boolean | undefined" @@ -9519,7 +9543,7 @@ ], "source": { "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "lineNumber": 287 + "lineNumber": 290 }, "initialIsOpen": false }, @@ -10003,6 +10027,26 @@ "any" ] }, + { + "tags": [ + "alpha" + ], + "id": "def-server.SavedObjectsFindOptions.aggs", + "type": "Object", + "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" + ], + "source": { + "path": "src/core/server/saved_objects/types.ts", + "lineNumber": 140 + }, + "signature": [ + "Record | undefined" + ] + }, { "tags": [], "id": "def-server.SavedObjectsFindOptions.namespaces", @@ -10011,7 +10055,7 @@ "description": [], "source": { "path": "src/core/server/saved_objects/types.ts", - "lineNumber": 119 + "lineNumber": 141 }, "signature": [ "string[] | undefined" @@ -10027,7 +10071,7 @@ ], "source": { "path": "src/core/server/saved_objects/types.ts", - "lineNumber": 127 + "lineNumber": 149 }, "signature": [ "Map | undefined" @@ -10043,7 +10087,7 @@ ], "source": { "path": "src/core/server/saved_objects/types.ts", - "lineNumber": 129 + "lineNumber": 151 }, "signature": [ "string | undefined" @@ -10059,7 +10103,7 @@ ], "source": { "path": "src/core/server/saved_objects/types.ts", - "lineNumber": 133 + "lineNumber": 155 }, "signature": [ { @@ -10129,7 +10173,7 @@ "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" @@ -10138,6 +10182,20 @@ "public" ], "children": [ + { + "tags": [], + "id": "def-server.SavedObjectsFindResponse.aggregations", + "type": "Uncategorized", + "label": "aggregations", + "description": [], + "source": { + "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "lineNumber": 177 + }, + "signature": [ + "A | undefined" + ] + }, { "tags": [], "id": "def-server.SavedObjectsFindResponse.saved_objects", @@ -10146,7 +10204,7 @@ "description": [], "source": { "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "lineNumber": 177 + "lineNumber": 178 }, "signature": [ { @@ -10167,7 +10225,7 @@ "description": [], "source": { "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "lineNumber": 178 + "lineNumber": 179 } }, { @@ -10178,7 +10236,7 @@ "description": [], "source": { "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "lineNumber": 179 + "lineNumber": 180 } }, { @@ -10189,7 +10247,7 @@ "description": [], "source": { "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "lineNumber": 180 + "lineNumber": 181 } }, { @@ -10200,7 +10258,7 @@ "description": [], "source": { "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "lineNumber": 181 + "lineNumber": 182 }, "signature": [ "string | undefined" @@ -11207,7 +11265,7 @@ ], "source": { "path": "src/core/server/saved_objects/service/lib/repository.ts", - "lineNumber": 150 + "lineNumber": 151 } }, { @@ -11220,7 +11278,7 @@ ], "source": { "path": "src/core/server/saved_objects/service/lib/repository.ts", - "lineNumber": 152 + "lineNumber": 153 }, "signature": [ "number | undefined" @@ -11229,7 +11287,7 @@ ], "source": { "path": "src/core/server/saved_objects/service/lib/repository.ts", - "lineNumber": 148 + "lineNumber": 149 }, "initialIsOpen": false }, @@ -11269,7 +11327,7 @@ ], "source": { "path": "src/core/server/saved_objects/service/lib/repository.ts", - "lineNumber": 113 + "lineNumber": 114 }, "signature": [ "boolean | undefined" @@ -11285,7 +11343,7 @@ ], "source": { "path": "src/core/server/saved_objects/service/lib/repository.ts", - "lineNumber": 115 + "lineNumber": 116 }, "signature": [ "SavedObjectsMigrationVersion", @@ -11302,7 +11360,7 @@ ], "source": { "path": "src/core/server/saved_objects/service/lib/repository.ts", - "lineNumber": 120 + "lineNumber": 121 }, "signature": [ "boolean | \"wait_for\" | undefined" @@ -11318,7 +11376,7 @@ ], "source": { "path": "src/core/server/saved_objects/service/lib/repository.ts", - "lineNumber": 124 + "lineNumber": 125 }, "signature": [ "Attributes | undefined" @@ -11327,7 +11385,7 @@ ], "source": { "path": "src/core/server/saved_objects/service/lib/repository.ts", - "lineNumber": 107 + "lineNumber": 108 }, "initialIsOpen": false }, @@ -11441,9 +11499,11 @@ "lineNumber": 27 }, "signature": [ - "(msg: string, meta: ", + " void" + " = ", + "LogMeta", + ">(msg: string, meta: Meta) => void" ] } ], @@ -11489,7 +11549,7 @@ ], "source": { "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "lineNumber": 360 + "lineNumber": 363 }, "signature": [ "string | undefined" @@ -11505,7 +11565,7 @@ ], "source": { "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "lineNumber": 364 + "lineNumber": 367 }, "signature": [ "string | undefined" @@ -11514,7 +11574,7 @@ ], "source": { "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "lineNumber": 356 + "lineNumber": 359 }, "initialIsOpen": false }, @@ -11537,13 +11597,13 @@ ], "source": { "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "lineNumber": 374 + "lineNumber": 377 } } ], "source": { "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "lineNumber": 370 + "lineNumber": 373 }, "initialIsOpen": false }, @@ -11731,7 +11791,7 @@ ], "source": { "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "lineNumber": 262 + "lineNumber": 265 }, "signature": [ "boolean | undefined" @@ -11740,7 +11800,7 @@ ], "source": { "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "lineNumber": 260 + "lineNumber": 263 }, "initialIsOpen": false }, @@ -11782,13 +11842,13 @@ ], "source": { "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "lineNumber": 271 + "lineNumber": 274 } } ], "source": { "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "lineNumber": 269 + "lineNumber": 272 }, "initialIsOpen": false }, @@ -11981,7 +12041,7 @@ "description": [], "source": { "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "lineNumber": 336 + "lineNumber": 339 }, "signature": [ "SavedObject", @@ -11998,7 +12058,7 @@ ], "source": { "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "lineNumber": 346 + "lineNumber": 349 }, "signature": [ "\"conflict\" | \"exactMatch\" | \"aliasMatch\"" @@ -12014,7 +12074,7 @@ ], "source": { "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "lineNumber": 350 + "lineNumber": 353 }, "signature": [ "string | undefined" @@ -12023,7 +12083,7 @@ ], "source": { "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "lineNumber": 335 + "lineNumber": 338 }, "initialIsOpen": false }, @@ -12393,7 +12453,7 @@ ], "source": { "path": "src/core/server/saved_objects/types.ts", - "lineNumber": 238 + "lineNumber": 260 } }, { @@ -12406,7 +12466,7 @@ ], "source": { "path": "src/core/server/saved_objects/types.ts", - "lineNumber": 245 + "lineNumber": 267 } }, { @@ -12419,7 +12479,7 @@ ], "source": { "path": "src/core/server/saved_objects/types.ts", - "lineNumber": 249 + "lineNumber": 271 }, "signature": [ { @@ -12441,7 +12501,7 @@ ], "source": { "path": "src/core/server/saved_objects/types.ts", - "lineNumber": 253 + "lineNumber": 275 }, "signature": [ "string | undefined" @@ -12457,7 +12517,7 @@ ], "source": { "path": "src/core/server/saved_objects/types.ts", - "lineNumber": 257 + "lineNumber": 279 }, "signature": [ "string | undefined" @@ -12473,7 +12533,7 @@ ], "source": { "path": "src/core/server/saved_objects/types.ts", - "lineNumber": 261 + "lineNumber": 283 }, "signature": [ { @@ -12495,7 +12555,7 @@ ], "source": { "path": "src/core/server/saved_objects/types.ts", - "lineNumber": 265 + "lineNumber": 287 }, "signature": [ { @@ -12526,7 +12586,7 @@ ], "source": { "path": "src/core/server/saved_objects/types.ts", - "lineNumber": 314 + "lineNumber": 336 }, "signature": [ "string | undefined" @@ -12542,7 +12602,7 @@ ], "source": { "path": "src/core/server/saved_objects/types.ts", - "lineNumber": 318 + "lineNumber": 340 }, "signature": [ { @@ -12558,7 +12618,7 @@ ], "source": { "path": "src/core/server/saved_objects/types.ts", - "lineNumber": 234 + "lineNumber": 256 }, "initialIsOpen": false }, @@ -12583,7 +12643,7 @@ ], "source": { "path": "src/core/server/saved_objects/types.ts", - "lineNumber": 330 + "lineNumber": 352 }, "signature": [ "boolean | undefined" @@ -12599,7 +12659,7 @@ ], "source": { "path": "src/core/server/saved_objects/types.ts", - "lineNumber": 334 + "lineNumber": 356 }, "signature": [ "string | undefined" @@ -12615,7 +12675,7 @@ ], "source": { "path": "src/core/server/saved_objects/types.ts", - "lineNumber": 339 + "lineNumber": 361 }, "signature": [ "string | undefined" @@ -12631,7 +12691,7 @@ ], "source": { "path": "src/core/server/saved_objects/types.ts", - "lineNumber": 344 + "lineNumber": 366 }, "signature": [ "((savedObject: ", @@ -12649,7 +12709,7 @@ ], "source": { "path": "src/core/server/saved_objects/types.ts", - "lineNumber": 349 + "lineNumber": 371 }, "signature": [ "((savedObject: ", @@ -12667,7 +12727,7 @@ ], "source": { "path": "src/core/server/saved_objects/types.ts", - "lineNumber": 358 + "lineNumber": 380 }, "signature": [ "((savedObject: ", @@ -12685,7 +12745,7 @@ ], "source": { "path": "src/core/server/saved_objects/types.ts", - "lineNumber": 369 + "lineNumber": 391 }, "signature": [ { @@ -12708,7 +12768,7 @@ ], "source": { "path": "src/core/server/saved_objects/types.ts", - "lineNumber": 412 + "lineNumber": 434 }, "signature": [ { @@ -12724,7 +12784,7 @@ ], "source": { "path": "src/core/server/saved_objects/types.ts", - "lineNumber": 326 + "lineNumber": 348 }, "initialIsOpen": false }, @@ -12796,7 +12856,7 @@ "section": "def-server.SavedObjectsUpdateOptions", "text": "SavedObjectsUpdateOptions" }, - " extends ", + " extends ", { "pluginId": "core", "scope": "server", @@ -12822,7 +12882,7 @@ ], "source": { "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "lineNumber": 211 + "lineNumber": 212 }, "signature": [ "string | undefined" @@ -12838,7 +12898,7 @@ ], "source": { "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "lineNumber": 213 + "lineNumber": 214 }, "signature": [ "SavedObjectReference", @@ -12855,16 +12915,32 @@ ], "source": { "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "lineNumber": 215 + "lineNumber": 216 }, "signature": [ "boolean | \"wait_for\" | undefined" ] + }, + { + "tags": [], + "id": "def-server.SavedObjectsUpdateOptions.upsert", + "type": "Uncategorized", + "label": "upsert", + "description": [ + "If specified, will be used to perform an upsert if the document doesn't exist" + ], + "source": { + "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "lineNumber": 218 + }, + "signature": [ + "Attributes | undefined" + ] } ], "source": { "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "lineNumber": 209 + "lineNumber": 210 }, "initialIsOpen": false }, @@ -12899,7 +12975,7 @@ "description": [], "source": { "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "lineNumber": 327 + "lineNumber": 330 }, "signature": [ "Partial" @@ -12913,7 +12989,7 @@ "description": [], "source": { "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "lineNumber": 328 + "lineNumber": 331 }, "signature": [ "SavedObjectReference", @@ -12923,7 +12999,7 @@ ], "source": { "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "lineNumber": 325 + "lineNumber": 328 }, "initialIsOpen": false } @@ -12980,10 +13056,10 @@ ], "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; }" + "{ 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; }" ], "initialIsOpen": false }, @@ -13018,7 +13094,7 @@ ], "source": { "path": "src/core/server/saved_objects/types.ts", - "lineNumber": 149 + "lineNumber": 171 }, "signature": [ "false | true | \"wait_for\"" @@ -13099,7 +13175,7 @@ ], "source": { "path": "src/core/server/saved_objects/types.ts", - "lineNumber": 213 + "lineNumber": 235 }, "signature": [ "{ get: (type: string, id: string, options?: SavedObjectsBaseOptions) => Promise>; delete: (type: string, id: string, options?: ", @@ -13259,7 +13335,7 @@ "description": [], "source": { "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "lineNumber": 380 + "lineNumber": 383 }, "signature": [ "SavedObjectsBaseOptions" @@ -13279,7 +13355,7 @@ "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,7 +13371,7 @@ "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; }" ], "initialIsOpen": false }, @@ -13447,7 +13523,7 @@ ], "source": { "path": "src/core/server/saved_objects/types.ts", - "lineNumber": 227 + "lineNumber": 249 }, "signature": [ "\"multiple\" | \"single\" | \"multiple-isolated\" | \"agnostic\"" diff --git a/api_docs/dashboard.json b/api_docs/dashboard.json index 36091a64a414a..bf891406a6339 100644 --- a/api_docs/dashboard.json +++ b/api_docs/dashboard.json @@ -663,7 +663,7 @@ "description": [], "source": { "path": "src/plugins/dashboard/public/application/embeddable/dashboard_container_factory.tsx", - "lineNumber": 32 + "lineNumber": 37 }, "signature": [ "true" @@ -677,7 +677,7 @@ "description": [], "source": { "path": "src/plugins/dashboard/public/application/embeddable/dashboard_container_factory.tsx", - "lineNumber": 33 + "lineNumber": 38 }, "signature": [ "\"dashboard\"" @@ -705,7 +705,27 @@ "description": [], "source": { "path": "src/plugins/dashboard/public/application/embeddable/dashboard_container_factory.tsx", - "lineNumber": 35 + "lineNumber": 41 + } + }, + { + "id": "def-public.DashboardContainerFactoryDefinition.Unnamed.$2", + "type": "Object", + "label": "persistableStateService", + "isRequired": true, + "signature": [ + { + "pluginId": "embeddable", + "scope": "common", + "docId": "kibEmbeddablePluginApi", + "section": "def-common.EmbeddablePersistableStateService", + "text": "EmbeddablePersistableStateService" + } + ], + "description": [], + "source": { + "path": "src/plugins/dashboard/public/application/embeddable/dashboard_container_factory.tsx", + "lineNumber": 42 } } ], @@ -713,7 +733,7 @@ "returnComment": [], "source": { "path": "src/plugins/dashboard/public/application/embeddable/dashboard_container_factory.tsx", - "lineNumber": 35 + "lineNumber": 40 } }, { @@ -727,7 +747,7 @@ "label": "isEditable", "source": { "path": "src/plugins/dashboard/public/application/embeddable/dashboard_container_factory.tsx", - "lineNumber": 37 + "lineNumber": 45 }, "tags": [], "returnComment": [] @@ -743,7 +763,7 @@ "label": "getDisplayName", "source": { "path": "src/plugins/dashboard/public/application/embeddable/dashboard_container_factory.tsx", - "lineNumber": 42 + "lineNumber": 50 }, "tags": [], "returnComment": [] @@ -769,7 +789,7 @@ "returnComment": [], "source": { "path": "src/plugins/dashboard/public/application/embeddable/dashboard_container_factory.tsx", - "lineNumber": 48 + "lineNumber": 56 } }, { @@ -793,7 +813,7 @@ "description": [], "source": { "path": "src/plugins/dashboard/public/application/embeddable/dashboard_container_factory.tsx", - "lineNumber": 59 + "lineNumber": 67 } }, { @@ -830,7 +850,7 @@ "description": [], "source": { "path": "src/plugins/dashboard/public/application/embeddable/dashboard_container_factory.tsx", - "lineNumber": 60 + "lineNumber": 68 } } ], @@ -880,15 +900,78 @@ "label": "create", "source": { "path": "src/plugins/dashboard/public/application/embeddable/dashboard_container_factory.tsx", - "lineNumber": 58 + "lineNumber": 66 }, "tags": [], "returnComment": [] + }, + { + "tags": [], + "id": "def-public.DashboardContainerFactoryDefinition.inject", + "type": "Function", + "label": "inject", + "description": [], + "source": { + "path": "src/plugins/dashboard/public/application/embeddable/dashboard_container_factory.tsx", + "lineNumber": 74 + }, + "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" + } + ] + }, + { + "tags": [], + "id": "def-public.DashboardContainerFactoryDefinition.extract", + "type": "Function", + "label": "extract", + "description": [], + "source": { + "path": "src/plugins/dashboard/public/application/embeddable/dashboard_container_factory.tsx", + "lineNumber": 76 + }, + "signature": [ + "(state: ", + { + "pluginId": "embeddable", + "scope": "common", + "docId": "kibEmbeddablePluginApi", + "section": "def-common.EmbeddableStateWithType", + "text": "EmbeddableStateWithType" + }, + ") => { state: ", + { + "pluginId": "embeddable", + "scope": "common", + "docId": "kibEmbeddablePluginApi", + "section": "def-common.EmbeddableStateWithType", + "text": "EmbeddableStateWithType" + }, + "; references: ", + "SavedObjectReference", + "[]; }" + ] } ], "source": { "path": "src/plugins/dashboard/public/application/embeddable/dashboard_container_factory.tsx", - "lineNumber": 29 + "lineNumber": 34 }, "initialIsOpen": false } @@ -1275,13 +1358,13 @@ "description": [], "source": { "path": "src/plugins/dashboard/public/plugin.tsx", - "lineNumber": 90 + "lineNumber": 92 } } ], "source": { "path": "src/plugins/dashboard/public/plugin.tsx", - "lineNumber": 89 + "lineNumber": 91 }, "initialIsOpen": false }, @@ -1810,7 +1893,7 @@ "description": [], "source": { "path": "src/plugins/dashboard/public/plugin.tsx", - "lineNumber": 87 + "lineNumber": 89 }, "signature": [ "UrlGeneratorContract<\"DASHBOARD_APP_URL_GENERATOR\">" @@ -1827,10 +1910,10 @@ ], "source": { "path": "src/plugins/dashboard/common/types.ts", - "lineNumber": 33 + "lineNumber": 38 }, "signature": [ - "Pick & { readonly id?: string | undefined; readonly type: string; }" + "Pick & { readonly id?: string | undefined; readonly type: string; }" ], "initialIsOpen": false } @@ -1947,7 +2030,7 @@ "description": [], "source": { "path": "src/plugins/dashboard/public/plugin.tsx", - "lineNumber": 120 + "lineNumber": 123 }, "signature": [ "void" @@ -1970,7 +2053,7 @@ "description": [], "source": { "path": "src/plugins/dashboard/public/plugin.tsx", - "lineNumber": 123 + "lineNumber": 126 }, "signature": [ "() => ", @@ -1983,6 +2066,20 @@ } ] }, + { + "tags": [], + "id": "def-public.DashboardStart.getDashboardContainerByValueRenderer", + "type": "Function", + "label": "getDashboardContainerByValueRenderer", + "description": [], + "source": { + "path": "src/plugins/dashboard/public/plugin.tsx", + "lineNumber": 127 + }, + "signature": [ + "() => React.FC" + ] + }, { "tags": [], "id": "def-public.DashboardStart.dashboardUrlGenerator", @@ -1991,7 +2088,7 @@ "description": [], "source": { "path": "src/plugins/dashboard/public/plugin.tsx", - "lineNumber": 124 + "lineNumber": 130 }, "signature": [ { @@ -2012,7 +2109,7 @@ "description": [], "source": { "path": "src/plugins/dashboard/public/plugin.tsx", - "lineNumber": 125 + "lineNumber": 131 }, "signature": [ { @@ -2023,25 +2120,11 @@ "text": "DashboardFeatureFlagConfig" } ] - }, - { - "tags": [], - "id": "def-public.DashboardStart.DashboardContainerByValueRenderer", - "type": "Function", - "label": "DashboardContainerByValueRenderer", - "description": [], - "source": { - "path": "src/plugins/dashboard/public/plugin.tsx", - "lineNumber": 126 - }, - "signature": [ - "React.FC" - ] } ], "source": { "path": "src/plugins/dashboard/public/plugin.tsx", - "lineNumber": 122 + "lineNumber": 125 }, "lifecycle": "start", "initialIsOpen": true @@ -2268,6 +2351,61 @@ } ], "interfaces": [ + { + "id": "def-common.DashboardContainerStateWithType", + "type": "Interface", + "label": "DashboardContainerStateWithType", + "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" + } + ], + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.DashboardContainerStateWithType.panels", + "type": "Object", + "label": "panels", + "description": [], + "source": { + "path": "src/plugins/dashboard/common/types.ts", + "lineNumber": 92 + }, + "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": 91 + }, + "initialIsOpen": false + }, { "id": "def-common.GridData", "type": "Interface", @@ -2396,7 +2534,7 @@ "lineNumber": 70 }, "signature": [ - "Pick, \"title\" | \"panelIndex\" | \"gridData\" | \"version\" | \"embeddableConfig\"> & { readonly type?: string | undefined; readonly name?: string | undefined; panelIndex: string; }" + "Pick, \"title\" | \"panelIndex\" | \"gridData\" | \"version\" | \"embeddableConfig\"> & { readonly type?: string | undefined; readonly name?: string | undefined; panelIndex: string; panelRefName?: string | undefined; }" ], "initialIsOpen": false }, @@ -2408,7 +2546,7 @@ "description": [], "source": { "path": "src/plugins/dashboard/common/types.ts", - "lineNumber": 59 + "lineNumber": 64 }, "signature": [ "Pick & { readonly id: string; readonly type: string; }" @@ -2423,7 +2561,7 @@ "description": [], "source": { "path": "src/plugins/dashboard/common/types.ts", - "lineNumber": 51 + "lineNumber": 56 }, "signature": [ "Pick & { readonly id: string; readonly type: string; }" @@ -2438,7 +2576,7 @@ "description": [], "source": { "path": "src/plugins/dashboard/common/types.ts", - "lineNumber": 43 + "lineNumber": 48 }, "signature": [ "Pick & { readonly id: string; readonly type: string; }" @@ -2453,7 +2591,7 @@ "description": [], "source": { "path": "src/plugins/dashboard/common/types.ts", - "lineNumber": 35 + "lineNumber": 40 }, "signature": [ "Pick, \"title\" | \"panelIndex\" | \"gridData\" | \"version\" | \"embeddableConfig\"> & { readonly id: string; readonly type: string; }" @@ -2468,10 +2606,10 @@ "description": [], "source": { "path": "src/plugins/dashboard/common/types.ts", - "lineNumber": 76 + "lineNumber": 81 }, "signature": [ - "Pick & { readonly id?: string | undefined; readonly type: string; }" + "Pick & { readonly id?: string | undefined; readonly type: string; }" ], "initialIsOpen": false }, @@ -2483,7 +2621,7 @@ "description": [], "source": { "path": "src/plugins/dashboard/common/types.ts", - "lineNumber": 67 + "lineNumber": 72 }, "signature": [ "Pick & { readonly id: string; readonly type: string; }" diff --git a/api_docs/data.json b/api_docs/data.json index 629e2aee35eb9..7d6834e439d60 100644 --- a/api_docs/data.json +++ b/api_docs/data.json @@ -1100,7 +1100,7 @@ "description": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_configs.ts", - "lineNumber": 65 + "lineNumber": 66 }, "signature": [ { @@ -1120,7 +1120,7 @@ "description": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_configs.ts", - "lineNumber": 66 + "lineNumber": 67 }, "signature": [ { @@ -1141,12 +1141,26 @@ "description": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_configs.ts", - "lineNumber": 67 + "lineNumber": 68 }, "signature": [ "string[] | undefined" ] }, + { + "tags": [], + "id": "def-public.AggConfigs.hierarchical", + "type": "CompoundType", + "label": "hierarchical", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_configs.ts", + "lineNumber": 69 + }, + "signature": [ + "boolean | undefined" + ] + }, { "tags": [], "id": "def-public.AggConfigs.aggs", @@ -1155,7 +1169,7 @@ "description": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_configs.ts", - "lineNumber": 70 + "lineNumber": 73 }, "signature": [ { @@ -1194,7 +1208,7 @@ "description": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_configs.ts", - "lineNumber": 73 + "lineNumber": 76 } }, { @@ -1226,7 +1240,7 @@ "description": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_configs.ts", - "lineNumber": 74 + "lineNumber": 77 } }, { @@ -1246,7 +1260,7 @@ "description": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_configs.ts", - "lineNumber": 75 + "lineNumber": 78 } } ], @@ -1254,7 +1268,7 @@ "returnComment": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_configs.ts", - "lineNumber": 72 + "lineNumber": 75 } }, { @@ -1277,7 +1291,7 @@ "description": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_configs.ts", - "lineNumber": 87 + "lineNumber": 91 } } ], @@ -1285,7 +1299,7 @@ "returnComment": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_configs.ts", - "lineNumber": 87 + "lineNumber": 91 } }, { @@ -1322,7 +1336,7 @@ "description": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_configs.ts", - "lineNumber": 91 + "lineNumber": 95 } } ], @@ -1330,7 +1344,7 @@ "returnComment": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_configs.ts", - "lineNumber": 91 + "lineNumber": 95 } }, { @@ -1360,7 +1374,7 @@ "description": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_configs.ts", - "lineNumber": 109 + "lineNumber": 113 } } ], @@ -1368,7 +1382,7 @@ "returnComment": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_configs.ts", - "lineNumber": 109 + "lineNumber": 113 } }, { @@ -1404,7 +1418,7 @@ "description": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_configs.ts", - "lineNumber": 123 + "lineNumber": 127 } }, { @@ -1418,7 +1432,7 @@ "description": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_configs.ts", - "lineNumber": 124 + "lineNumber": 128 } } ], @@ -1462,7 +1476,7 @@ "label": "createAggConfig", "source": { "path": "src/plugins/data/common/search/aggs/agg_configs.ts", - "lineNumber": 122 + "lineNumber": 126 }, "tags": [], "returnComment": [] @@ -1506,7 +1520,7 @@ ], "source": { "path": "src/plugins/data/common/search/aggs/agg_configs.ts", - "lineNumber": 165 + "lineNumber": 169 } } ], @@ -1514,7 +1528,7 @@ "returnComment": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_configs.ts", - "lineNumber": 165 + "lineNumber": 169 } }, { @@ -1522,30 +1536,15 @@ "type": "Function", "label": "toDsl", "signature": [ - "(hierarchical?: boolean) => Record" + "() => 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 - } - } - ], + "children": [], "tags": [], "returnComment": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_configs.ts", - "lineNumber": 177 + "lineNumber": 181 } }, { @@ -1569,7 +1568,7 @@ "returnComment": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_configs.ts", - "lineNumber": 246 + "lineNumber": 250 } }, { @@ -1599,7 +1598,7 @@ "description": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_configs.ts", - "lineNumber": 250 + "lineNumber": 254 } } ], @@ -1607,7 +1606,7 @@ "returnComment": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_configs.ts", - "lineNumber": 250 + "lineNumber": 254 } }, { @@ -1638,7 +1637,7 @@ "description": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_configs.ts", - "lineNumber": 254 + "lineNumber": 258 } } ], @@ -1646,7 +1645,7 @@ "returnComment": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_configs.ts", - "lineNumber": 254 + "lineNumber": 258 } }, { @@ -1677,7 +1676,7 @@ "description": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_configs.ts", - "lineNumber": 258 + "lineNumber": 262 } } ], @@ -1685,7 +1684,7 @@ "returnComment": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_configs.ts", - "lineNumber": 258 + "lineNumber": 262 } }, { @@ -1716,7 +1715,7 @@ "description": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_configs.ts", - "lineNumber": 262 + "lineNumber": 266 } } ], @@ -1724,7 +1723,7 @@ "returnComment": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_configs.ts", - "lineNumber": 262 + "lineNumber": 266 } }, { @@ -1755,7 +1754,7 @@ "description": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_configs.ts", - "lineNumber": 266 + "lineNumber": 270 } } ], @@ -1763,7 +1762,7 @@ "returnComment": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_configs.ts", - "lineNumber": 266 + "lineNumber": 270 } }, { @@ -1794,7 +1793,7 @@ "description": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_configs.ts", - "lineNumber": 270 + "lineNumber": 274 } } ], @@ -1802,7 +1801,7 @@ "returnComment": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_configs.ts", - "lineNumber": 270 + "lineNumber": 274 } }, { @@ -1826,7 +1825,7 @@ "returnComment": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_configs.ts", - "lineNumber": 274 + "lineNumber": 278 } }, { @@ -1857,7 +1856,7 @@ "description": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_configs.ts", - "lineNumber": 288 + "lineNumber": 292 } } ], @@ -1865,7 +1864,7 @@ "returnComment": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_configs.ts", - "lineNumber": 288 + "lineNumber": 292 } }, { @@ -1893,7 +1892,7 @@ "returnComment": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_configs.ts", - "lineNumber": 303 + "lineNumber": 307 } }, { @@ -1928,7 +1927,7 @@ ], "source": { "path": "src/plugins/data/common/search/aggs/agg_configs.ts", - "lineNumber": 317 + "lineNumber": 321 } } ], @@ -1938,7 +1937,7 @@ "returnComment": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_configs.ts", - "lineNumber": 317 + "lineNumber": 321 } }, { @@ -1985,7 +1984,7 @@ "description": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_configs.ts", - "lineNumber": 326 + "lineNumber": 330 } }, { @@ -2006,7 +2005,7 @@ "description": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_configs.ts", - "lineNumber": 326 + "lineNumber": 330 } } ], @@ -2014,13 +2013,13 @@ "returnComment": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_configs.ts", - "lineNumber": 326 + "lineNumber": 330 } } ], "source": { "path": "src/plugins/data/common/search/aggs/agg_configs.ts", - "lineNumber": 64 + "lineNumber": 65 }, "initialIsOpen": false }, @@ -2186,7 +2185,7 @@ "description": [], "source": { "path": "src/plugins/data/public/plugin.ts", - "lineNumber": 71 + "lineNumber": 70 } } ], @@ -2194,7 +2193,7 @@ "returnComment": [], "source": { "path": "src/plugins/data/public/plugin.ts", - "lineNumber": 71 + "lineNumber": 70 } }, { @@ -2261,7 +2260,7 @@ "description": [], "source": { "path": "src/plugins/data/public/plugin.ts", - "lineNumber": 81 + "lineNumber": 80 } }, { @@ -2275,7 +2274,7 @@ "description": [], "source": { "path": "src/plugins/data/public/plugin.ts", - "lineNumber": 82 + "lineNumber": 81 } } ], @@ -2283,7 +2282,7 @@ "returnComment": [], "source": { "path": "src/plugins/data/public/plugin.ts", - "lineNumber": 80 + "lineNumber": 79 } }, { @@ -2329,7 +2328,7 @@ "description": [], "source": { "path": "src/plugins/data/public/plugin.ts", - "lineNumber": 131 + "lineNumber": 127 } }, { @@ -2343,7 +2342,7 @@ "description": [], "source": { "path": "src/plugins/data/public/plugin.ts", - "lineNumber": 131 + "lineNumber": 127 } } ], @@ -2351,7 +2350,7 @@ "returnComment": [], "source": { "path": "src/plugins/data/public/plugin.ts", - "lineNumber": 131 + "lineNumber": 127 } }, { @@ -2367,13 +2366,13 @@ "returnComment": [], "source": { "path": "src/plugins/data/public/plugin.ts", - "lineNumber": 213 + "lineNumber": 209 } } ], "source": { "path": "src/plugins/data/public/plugin.ts", - "lineNumber": 55 + "lineNumber": 54 }, "initialIsOpen": false }, @@ -5947,7 +5946,7 @@ "description": [], "source": { "path": "src/plugins/data/common/search/search_source/search_source.ts", - "lineNumber": 111 + "lineNumber": 129 }, "signature": [ "Record[]" @@ -5979,7 +5978,7 @@ "description": [], "source": { "path": "src/plugins/data/common/search/search_source/search_source.ts", - "lineNumber": 115 + "lineNumber": 133 } }, { @@ -5999,7 +5998,7 @@ "description": [], "source": { "path": "src/plugins/data/common/search/search_source/search_source.ts", - "lineNumber": 115 + "lineNumber": 133 } } ], @@ -6007,7 +6006,7 @@ "returnComment": [], "source": { "path": "src/plugins/data/common/search/search_source/search_source.ts", - "lineNumber": 115 + "lineNumber": 133 } }, { @@ -6032,7 +6031,7 @@ "description": [], "source": { "path": "src/plugins/data/common/search/search_source/search_source.ts", - "lineNumber": 133 + "lineNumber": 151 } } ], @@ -6040,7 +6039,7 @@ "returnComment": [], "source": { "path": "src/plugins/data/common/search/search_source/search_source.ts", - "lineNumber": 133 + "lineNumber": 151 } }, { @@ -6075,7 +6074,7 @@ ], "source": { "path": "src/plugins/data/common/search/search_source/search_source.ts", - "lineNumber": 142 + "lineNumber": 160 } }, { @@ -6098,7 +6097,7 @@ ], "source": { "path": "src/plugins/data/common/search/search_source/search_source.ts", - "lineNumber": 142 + "lineNumber": 160 } } ], @@ -6106,7 +6105,7 @@ "returnComment": [], "source": { "path": "src/plugins/data/common/search/search_source/search_source.ts", - "lineNumber": 142 + "lineNumber": 160 } }, { @@ -6133,7 +6132,7 @@ ], "source": { "path": "src/plugins/data/common/search/search_source/search_source.ts", - "lineNumber": 154 + "lineNumber": 172 } } ], @@ -6141,7 +6140,7 @@ "returnComment": [], "source": { "path": "src/plugins/data/common/search/search_source/search_source.ts", - "lineNumber": 154 + "lineNumber": 172 } }, { @@ -6182,7 +6181,7 @@ ], "source": { "path": "src/plugins/data/common/search/search_source/search_source.ts", - "lineNumber": 165 + "lineNumber": 183 } } ], @@ -6192,7 +6191,7 @@ "returnComment": [], "source": { "path": "src/plugins/data/common/search/search_source/search_source.ts", - "lineNumber": 165 + "lineNumber": 183 } }, { @@ -6210,7 +6209,7 @@ "returnComment": [], "source": { "path": "src/plugins/data/common/search/search_source/search_source.ts", - "lineNumber": 173 + "lineNumber": 191 } }, { @@ -6235,7 +6234,7 @@ "returnComment": [], "source": { "path": "src/plugins/data/common/search/search_source/search_source.ts", - "lineNumber": 180 + "lineNumber": 198 } }, { @@ -6268,7 +6267,7 @@ "description": [], "source": { "path": "src/plugins/data/common/search/search_source/search_source.ts", - "lineNumber": 187 + "lineNumber": 205 } }, { @@ -6282,7 +6281,7 @@ "description": [], "source": { "path": "src/plugins/data/common/search/search_source/search_source.ts", - "lineNumber": 187 + "lineNumber": 205 } } ], @@ -6290,7 +6289,7 @@ "returnComment": [], "source": { "path": "src/plugins/data/common/search/search_source/search_source.ts", - "lineNumber": 187 + "lineNumber": 205 } }, { @@ -6323,7 +6322,7 @@ "description": [], "source": { "path": "src/plugins/data/common/search/search_source/search_source.ts", - "lineNumber": 198 + "lineNumber": 216 } } ], @@ -6331,7 +6330,7 @@ "returnComment": [], "source": { "path": "src/plugins/data/common/search/search_source/search_source.ts", - "lineNumber": 198 + "lineNumber": 216 } }, { @@ -6356,7 +6355,7 @@ "returnComment": [], "source": { "path": "src/plugins/data/common/search/search_source/search_source.ts", - "lineNumber": 205 + "lineNumber": 223 } }, { @@ -6381,7 +6380,7 @@ "returnComment": [], "source": { "path": "src/plugins/data/common/search/search_source/search_source.ts", - "lineNumber": 212 + "lineNumber": 230 } }, { @@ -6413,7 +6412,7 @@ "description": [], "source": { "path": "src/plugins/data/common/search/search_source/search_source.ts", - "lineNumber": 226 + "lineNumber": 244 } } ], @@ -6421,7 +6420,7 @@ "returnComment": [], "source": { "path": "src/plugins/data/common/search/search_source/search_source.ts", - "lineNumber": 226 + "lineNumber": 244 } }, { @@ -6472,7 +6471,7 @@ ], "source": { "path": "src/plugins/data/common/search/search_source/search_source.ts", - "lineNumber": 238 + "lineNumber": 256 } }, { @@ -6494,7 +6493,7 @@ ], "source": { "path": "src/plugins/data/common/search/search_source/search_source.ts", - "lineNumber": 238 + "lineNumber": 256 } } ], @@ -6506,7 +6505,7 @@ ], "source": { "path": "src/plugins/data/common/search/search_source/search_source.ts", - "lineNumber": 238 + "lineNumber": 256 } }, { @@ -6534,7 +6533,7 @@ "returnComment": [], "source": { "path": "src/plugins/data/common/search/search_source/search_source.ts", - "lineNumber": 248 + "lineNumber": 266 } }, { @@ -6553,8 +6552,16 @@ ") => ", "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)" @@ -6577,7 +6584,7 @@ "description": [], "source": { "path": "src/plugins/data/common/search/search_source/search_source.ts", - "lineNumber": 256 + "lineNumber": 275 } } ], @@ -6585,7 +6592,7 @@ "returnComment": [], "source": { "path": "src/plugins/data/common/search/search_source/search_source.ts", - "lineNumber": 256 + "lineNumber": 274 } }, { @@ -6626,7 +6633,7 @@ "description": [], "source": { "path": "src/plugins/data/common/search/search_source/search_source.ts", - "lineNumber": 283 + "lineNumber": 312 } } ], @@ -6636,7 +6643,7 @@ "returnComment": [], "source": { "path": "src/plugins/data/common/search/search_source/search_source.ts", - "lineNumber": 283 + "lineNumber": 312 } }, { @@ -6693,7 +6700,7 @@ "description": [], "source": { "path": "src/plugins/data/common/search/search_source/search_source.ts", - "lineNumber": 293 + "lineNumber": 326 } } ], @@ -6703,7 +6710,7 @@ "returnComment": [], "source": { "path": "src/plugins/data/common/search/search_source/search_source.ts", - "lineNumber": 292 + "lineNumber": 325 } }, { @@ -6711,7 +6718,7 @@ "type": "Function", "label": "getSearchRequestBody", "signature": [ - "() => Promise" + "() => any" ], "description": [ "\nReturns body contents of the search request, often referred as query DSL." @@ -6721,7 +6728,7 @@ "returnComment": [], "source": { "path": "src/plugins/data/common/search/search_source/search_source.ts", - "lineNumber": 301 + "lineNumber": 334 } }, { @@ -6741,7 +6748,7 @@ "returnComment": [], "source": { "path": "src/plugins/data/common/search/search_source/search_source.ts", - "lineNumber": 310 + "lineNumber": 342 } }, { @@ -6773,7 +6780,7 @@ "description": [], "source": { "path": "src/plugins/data/common/search/search_source/search_source.ts", - "lineNumber": 688 + "lineNumber": 826 } } ], @@ -6781,7 +6788,7 @@ "returnComment": [], "source": { "path": "src/plugins/data/common/search/search_source/search_source.ts", - "lineNumber": 688 + "lineNumber": 826 } }, { @@ -6803,13 +6810,13 @@ "returnComment": [], "source": { "path": "src/plugins/data/common/search/search_source/search_source.ts", - "lineNumber": 717 + "lineNumber": 855 } } ], "source": { "path": "src/plugins/data/common/search/search_source/search_source.ts", - "lineNumber": 103 + "lineNumber": 121 }, "initialIsOpen": false } @@ -8278,7 +8285,7 @@ "description": [], "source": { "path": "src/plugins/data/public/types.ts", - "lineNumber": 68 + "lineNumber": 60 }, "signature": [ "({ data, negate, }: ", @@ -8302,7 +8309,7 @@ "description": [], "source": { "path": "src/plugins/data/public/types.ts", - "lineNumber": 69 + "lineNumber": 61 }, "signature": [ "typeof ", @@ -8312,7 +8319,7 @@ ], "source": { "path": "src/plugins/data/public/types.ts", - "lineNumber": 67 + "lineNumber": 59 }, "initialIsOpen": false }, @@ -8333,7 +8340,7 @@ "description": [], "source": { "path": "src/plugins/data/public/types.ts", - "lineNumber": 60 + "lineNumber": 52 }, "signature": [ "React.ComponentType<", @@ -8355,7 +8362,7 @@ "description": [], "source": { "path": "src/plugins/data/public/types.ts", - "lineNumber": 61 + "lineNumber": 53 }, "signature": [ "React.ComponentType<", @@ -8372,7 +8379,7 @@ ], "source": { "path": "src/plugins/data/public/types.ts", - "lineNumber": 59 + "lineNumber": 51 }, "initialIsOpen": false }, @@ -8526,7 +8533,7 @@ "description": [], "source": { "path": "src/plugins/data/public/types.ts", - "lineNumber": 116 + "lineNumber": 108 } }, { @@ -8537,7 +8544,7 @@ "description": [], "source": { "path": "src/plugins/data/public/types.ts", - "lineNumber": 117 + "lineNumber": 109 }, "signature": [ { @@ -8557,7 +8564,7 @@ "description": [], "source": { "path": "src/plugins/data/public/types.ts", - "lineNumber": 118 + "lineNumber": 110 }, "signature": [ { @@ -8577,7 +8584,7 @@ "description": [], "source": { "path": "src/plugins/data/public/types.ts", - "lineNumber": 119 + "lineNumber": 111 }, "signature": [ { @@ -8597,7 +8604,7 @@ "description": [], "source": { "path": "src/plugins/data/public/types.ts", - "lineNumber": 120 + "lineNumber": 112 }, "signature": [ { @@ -8617,7 +8624,7 @@ "description": [], "source": { "path": "src/plugins/data/public/types.ts", - "lineNumber": 121 + "lineNumber": 113 }, "signature": [ { @@ -8638,7 +8645,7 @@ "description": [], "source": { "path": "src/plugins/data/public/types.ts", - "lineNumber": 122 + "lineNumber": 114 }, "signature": [ { @@ -8658,7 +8665,7 @@ "description": [], "source": { "path": "src/plugins/data/public/types.ts", - "lineNumber": 123 + "lineNumber": 115 }, "signature": [ { @@ -8674,7 +8681,7 @@ ], "source": { "path": "src/plugins/data/public/types.ts", - "lineNumber": 115 + "lineNumber": 107 }, "initialIsOpen": false }, @@ -8718,7 +8725,7 @@ "label": "indexType", "description": [], "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": [ @@ -8727,7 +8734,7 @@ } ], "source": { - "path": "src/plugins/data/common/search/es_search/types.ts", + "path": "src/plugins/data/common/search/strategies/es_search/types.ts", "lineNumber": 18 }, "initialIsOpen": false @@ -10312,7 +10319,7 @@ ], "source": { "path": "src/plugins/data/common/search/types.ts", - "lineNumber": 87 + "lineNumber": 94 }, "signature": [ "AbortSignal | undefined" @@ -10328,7 +10335,7 @@ ], "source": { "path": "src/plugins/data/common/search/types.ts", - "lineNumber": 92 + "lineNumber": 99 }, "signature": [ "string | undefined" @@ -10344,7 +10351,7 @@ ], "source": { "path": "src/plugins/data/common/search/types.ts", - "lineNumber": 98 + "lineNumber": 105 }, "signature": [ "boolean | undefined" @@ -10360,7 +10367,7 @@ ], "source": { "path": "src/plugins/data/common/search/types.ts", - "lineNumber": 103 + "lineNumber": 110 }, "signature": [ "string | undefined" @@ -10376,7 +10383,7 @@ ], "source": { "path": "src/plugins/data/common/search/types.ts", - "lineNumber": 108 + "lineNumber": 115 }, "signature": [ "boolean | undefined" @@ -10392,7 +10399,7 @@ ], "source": { "path": "src/plugins/data/common/search/types.ts", - "lineNumber": 114 + "lineNumber": 121 }, "signature": [ "boolean | undefined" @@ -10408,7 +10415,7 @@ ], "source": { "path": "src/plugins/data/common/search/types.ts", - "lineNumber": 120 + "lineNumber": 126 }, "signature": [ { @@ -10420,11 +10427,34 @@ }, " | undefined" ] + }, + { + "tags": [], + "id": "def-public.ISearchOptions.inspector", + "type": "Object", + "label": "inspector", + "description": [ + "\nInspector integration options" + ], + "source": { + "path": "src/plugins/data/common/search/types.ts", + "lineNumber": 131 + }, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.IInspectorInfo", + "text": "IInspectorInfo" + }, + " | undefined" + ] } ], "source": { "path": "src/plugins/data/common/search/types.ts", - "lineNumber": 83 + "lineNumber": 90 }, "initialIsOpen": false }, @@ -10449,7 +10479,7 @@ ], "source": { "path": "src/plugins/data/common/search/search_source/types.ts", - "lineNumber": 30 + "lineNumber": 31 }, "signature": [ "(fields?: ", @@ -10481,7 +10511,7 @@ ], "source": { "path": "src/plugins/data/common/search/search_source/types.ts", - "lineNumber": 34 + "lineNumber": 35 }, "signature": [ "() => Pick<", @@ -10498,7 +10528,7 @@ ], "source": { "path": "src/plugins/data/common/search/search_source/types.ts", - "lineNumber": 25 + "lineNumber": 26 }, "initialIsOpen": false }, @@ -10779,7 +10809,7 @@ "description": [], "source": { "path": "src/plugins/data/common/search/search_source/fetch/types.ts", - "lineNumber": 40 + "lineNumber": 31 } }, { @@ -10790,7 +10820,7 @@ "description": [], "source": { "path": "src/plugins/data/common/search/search_source/fetch/types.ts", - "lineNumber": 41 + "lineNumber": 32 } }, { @@ -10801,7 +10831,7 @@ "description": [], "source": { "path": "src/plugins/data/common/search/search_source/fetch/types.ts", - "lineNumber": 42 + "lineNumber": 33 } }, { @@ -10812,7 +10842,7 @@ "description": [], "source": { "path": "src/plugins/data/common/search/search_source/fetch/types.ts", - "lineNumber": 43 + "lineNumber": 34 } }, { @@ -10823,7 +10853,7 @@ "description": [], "source": { "path": "src/plugins/data/common/search/search_source/fetch/types.ts", - "lineNumber": 44 + "lineNumber": 35 } }, { @@ -10834,13 +10864,13 @@ "description": [], "source": { "path": "src/plugins/data/common/search/search_source/fetch/types.ts", - "lineNumber": 45 + "lineNumber": 36 } } ], "source": { "path": "src/plugins/data/common/search/search_source/fetch/types.ts", - "lineNumber": 39 + "lineNumber": 30 }, "initialIsOpen": false }, @@ -10861,7 +10891,7 @@ "description": [], "source": { "path": "src/plugins/data/common/search/search_source/types.ts", - "lineNumber": 62 + "lineNumber": 71 }, "signature": [ "string | undefined" @@ -10877,7 +10907,7 @@ ], "source": { "path": "src/plugins/data/common/search/search_source/types.ts", - "lineNumber": 66 + "lineNumber": 75 }, "signature": [ { @@ -10900,7 +10930,7 @@ ], "source": { "path": "src/plugins/data/common/search/search_source/types.ts", - "lineNumber": 70 + "lineNumber": 79 }, "signature": [ { @@ -10947,7 +10977,7 @@ ], "source": { "path": "src/plugins/data/common/search/search_source/types.ts", - "lineNumber": 74 + "lineNumber": 83 }, "signature": [ "Record | Record[] | undefined" + } ] }, { @@ -10993,7 +11030,7 @@ "description": [], "source": { "path": "src/plugins/data/common/search/search_source/types.ts", - "lineNumber": 75 + "lineNumber": 84 }, "signature": [ "any" @@ -11007,7 +11044,7 @@ "description": [], "source": { "path": "src/plugins/data/common/search/search_source/types.ts", - "lineNumber": 76 + "lineNumber": 85 }, "signature": [ "boolean | undefined" @@ -11021,7 +11058,7 @@ "description": [], "source": { "path": "src/plugins/data/common/search/search_source/types.ts", - "lineNumber": 77 + "lineNumber": 86 }, "signature": [ "number | boolean | undefined" @@ -11030,17 +11067,25 @@ { "tags": [], "id": "def-public.SearchSourceFields.aggs", - "type": "Any", + "type": "CompoundType", "label": "aggs", "description": [ "\n{@link AggConfigs}" ], "source": { "path": "src/plugins/data/common/search/search_source/types.ts", - "lineNumber": 81 + "lineNumber": 90 }, "signature": [ - "any" + "object | ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.AggConfigs", + "text": "AggConfigs" + }, + " | (() => object) | undefined" ] }, { @@ -11051,7 +11096,7 @@ "description": [], "source": { "path": "src/plugins/data/common/search/search_source/types.ts", - "lineNumber": 82 + "lineNumber": 91 }, "signature": [ "number | undefined" @@ -11065,7 +11110,7 @@ "description": [], "source": { "path": "src/plugins/data/common/search/search_source/types.ts", - "lineNumber": 83 + "lineNumber": 92 }, "signature": [ "number | undefined" @@ -11079,7 +11124,7 @@ "description": [], "source": { "path": "src/plugins/data/common/search/search_source/types.ts", - "lineNumber": 84 + "lineNumber": 93 }, "signature": [ "string | boolean | string[] | undefined" @@ -11093,7 +11138,7 @@ "description": [], "source": { "path": "src/plugins/data/common/search/search_source/types.ts", - "lineNumber": 85 + "lineNumber": 94 }, "signature": [ "boolean | undefined" @@ -11109,7 +11154,7 @@ ], "source": { "path": "src/plugins/data/common/search/search_source/types.ts", - "lineNumber": 89 + "lineNumber": 98 }, "signature": [ { @@ -11134,7 +11179,7 @@ ], "source": { "path": "src/plugins/data/common/search/search_source/types.ts", - "lineNumber": 95 + "lineNumber": 104 }, "signature": [ "string | boolean | string[] | undefined" @@ -11150,7 +11195,7 @@ ], "source": { "path": "src/plugins/data/common/search/search_source/types.ts", - "lineNumber": 99 + "lineNumber": 108 }, "signature": [ { @@ -11171,7 +11216,7 @@ "description": [], "source": { "path": "src/plugins/data/common/search/search_source/types.ts", - "lineNumber": 100 + "lineNumber": 109 }, "signature": [ { @@ -11192,7 +11237,7 @@ "description": [], "source": { "path": "src/plugins/data/common/search/search_source/types.ts", - "lineNumber": 101 + "lineNumber": 110 }, "signature": [ "string | undefined" @@ -11206,7 +11251,7 @@ "description": [], "source": { "path": "src/plugins/data/common/search/search_source/types.ts", - "lineNumber": 102 + "lineNumber": 111 }, "signature": [ "number | undefined" @@ -11220,7 +11265,7 @@ "description": [], "source": { "path": "src/plugins/data/common/search/search_source/types.ts", - "lineNumber": 104 + "lineNumber": 113 }, "signature": [ { @@ -11236,7 +11281,7 @@ ], "source": { "path": "src/plugins/data/common/search/search_source/types.ts", - "lineNumber": 61 + "lineNumber": 70 }, "initialIsOpen": false }, @@ -11344,7 +11389,7 @@ "description": [], "source": { "path": "src/plugins/data/common/search/search_source/types.ts", - "lineNumber": 39 + "lineNumber": 40 }, "initialIsOpen": false } @@ -11507,7 +11552,7 @@ "label": "ES_SEARCH_STRATEGY", "description": [], "source": { - "path": "src/plugins/data/common/search/es_search/types.ts", + "path": "src/plugins/data/common/search/strategies/es_search/types.ts", "lineNumber": 12 }, "signature": [ @@ -11604,10 +11649,10 @@ "description": [], "source": { "path": "src/plugins/data/common/search/search_source/types.ts", - "lineNumber": 49 + "lineNumber": 55 }, "signature": [ - "{ [x: string]: SortDirection | SortDirectionNumeric; }" + "{ [x: string]: SortDirection | SortDirectionNumeric | SortDirectionFormat; }" ], "initialIsOpen": false }, @@ -11823,7 +11868,7 @@ "description": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_type.ts", - "lineNumber": 59 + "lineNumber": 62 }, "signature": [ "AggType>" @@ -11837,7 +11882,7 @@ "tags": [], "description": [], "source": { - "path": "src/plugins/data/common/search/es_search/types.ts", + "path": "src/plugins/data/common/search/strategies/es_search/types.ts", "lineNumber": 22 }, "signature": [ @@ -12011,31 +12056,37 @@ ], "source": { "path": "src/plugins/data/common/search/search_source/types.ts", - "lineNumber": 19 + "lineNumber": 20 }, "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" + } ], "initialIsOpen": false }, @@ -13955,7 +14006,7 @@ "description": [], "source": { "path": "src/plugins/data/public/index.ts", - "lineNumber": 408 + "lineNumber": 409 }, "signature": [ "typeof ", @@ -13976,7 +14027,7 @@ "description": [], "source": { "path": "src/plugins/data/public/index.ts", - "lineNumber": 409 + "lineNumber": 410 }, "signature": [ "typeof ", @@ -13997,7 +14048,7 @@ "description": [], "source": { "path": "src/plugins/data/public/index.ts", - "lineNumber": 410 + "lineNumber": 411 }, "signature": [ "({ display: string; val: string; enabled(agg: ", @@ -14019,7 +14070,7 @@ "description": [], "source": { "path": "src/plugins/data/public/index.ts", - "lineNumber": 411 + "lineNumber": 412 }, "signature": [ "typeof ", @@ -14040,7 +14091,7 @@ "description": [], "source": { "path": "src/plugins/data/public/index.ts", - "lineNumber": 412 + "lineNumber": 413 }, "signature": [ "typeof ", @@ -14061,7 +14112,7 @@ "description": [], "source": { "path": "src/plugins/data/public/index.ts", - "lineNumber": 413 + "lineNumber": 414 }, "signature": [ "typeof ", @@ -14082,7 +14133,7 @@ "description": [], "source": { "path": "src/plugins/data/public/index.ts", - "lineNumber": 414 + "lineNumber": 415 }, "signature": [ "typeof ", @@ -14103,7 +14154,7 @@ "description": [], "source": { "path": "src/plugins/data/public/index.ts", - "lineNumber": 415 + "lineNumber": 416 }, "signature": [ "(agg: ", @@ -14125,7 +14176,7 @@ "description": [], "source": { "path": "src/plugins/data/public/index.ts", - "lineNumber": 416 + "lineNumber": 417 }, "signature": [ "(agg: ", @@ -14147,7 +14198,7 @@ "description": [], "source": { "path": "src/plugins/data/public/index.ts", - "lineNumber": 417 + "lineNumber": 418 }, "signature": [ "(...types: string[]) => (agg: ", @@ -14169,7 +14220,7 @@ "description": [], "source": { "path": "src/plugins/data/public/index.ts", - "lineNumber": 418 + "lineNumber": 419 }, "signature": [ "typeof ", @@ -14190,7 +14241,7 @@ "description": [], "source": { "path": "src/plugins/data/public/index.ts", - "lineNumber": 419 + "lineNumber": 420 }, "signature": [ "typeof ", @@ -14211,7 +14262,7 @@ "description": [], "source": { "path": "src/plugins/data/public/index.ts", - "lineNumber": 420 + "lineNumber": 421 } }, { @@ -14222,7 +14273,7 @@ "description": [], "source": { "path": "src/plugins/data/public/index.ts", - "lineNumber": 421 + "lineNumber": 422 }, "signature": [ "typeof ", @@ -14243,7 +14294,7 @@ "description": [], "source": { "path": "src/plugins/data/public/index.ts", - "lineNumber": 422 + "lineNumber": 423 }, "signature": [ "typeof ", @@ -14264,7 +14315,7 @@ "description": [], "source": { "path": "src/plugins/data/public/index.ts", - "lineNumber": 423 + "lineNumber": 424 }, "signature": [ "typeof ", @@ -14285,7 +14336,7 @@ "description": [], "source": { "path": "src/plugins/data/public/index.ts", - "lineNumber": 424 + "lineNumber": 425 } }, { @@ -14296,7 +14347,7 @@ "description": [], "source": { "path": "src/plugins/data/public/index.ts", - "lineNumber": 425 + "lineNumber": 426 }, "signature": [ "string[]" @@ -14310,7 +14361,7 @@ "description": [], "source": { "path": "src/plugins/data/public/index.ts", - "lineNumber": 426 + "lineNumber": 427 }, "signature": [ "typeof ", @@ -14331,7 +14382,7 @@ "description": [], "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; })[]" @@ -14345,7 +14396,7 @@ "description": [], "source": { "path": "src/plugins/data/public/index.ts", - "lineNumber": 428 + "lineNumber": 429 }, "signature": [ "(column: ", @@ -14367,7 +14418,7 @@ "description": [], "source": { "path": "src/plugins/data/public/index.ts", - "lineNumber": 429 + "lineNumber": 430 }, "signature": [ "(column: ", @@ -14394,30 +14445,9 @@ "label": "aggs", "source": { "path": "src/plugins/data/public/index.ts", - "lineNumber": 407 + "lineNumber": 408 } }, - { - "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" - } - ] - }, { "tags": [], "id": "def-public.search.getResponseInspectorStats", @@ -14486,7 +14516,7 @@ "label": "search", "source": { "path": "src/plugins/data/public/index.ts", - "lineNumber": 406 + "lineNumber": 407 }, "initialIsOpen": false }, @@ -14523,7 +14553,7 @@ "description": [], "source": { "path": "src/plugins/data/public/types.ts", - "lineNumber": 46 + "lineNumber": 42 }, "signature": [ "{ getQuerySuggestions: ", @@ -14545,7 +14575,7 @@ "description": [], "source": { "path": "src/plugins/data/public/types.ts", - "lineNumber": 47 + "lineNumber": 43 }, "signature": [ { @@ -14565,7 +14595,7 @@ "description": [], "source": { "path": "src/plugins/data/public/types.ts", - "lineNumber": 48 + "lineNumber": 44 }, "signature": [ "Pick<", @@ -14587,7 +14617,7 @@ "description": [], "source": { "path": "src/plugins/data/public/types.ts", - "lineNumber": 49 + "lineNumber": 45 }, "signature": [ "{ filterManager: ", @@ -14617,7 +14647,7 @@ ], "source": { "path": "src/plugins/data/public/types.ts", - "lineNumber": 45 + "lineNumber": 41 }, "lifecycle": "setup", "initialIsOpen": true @@ -14641,7 +14671,7 @@ ], "source": { "path": "src/plugins/data/public/types.ts", - "lineNumber": 80 + "lineNumber": 72 }, "signature": [ { @@ -14663,7 +14693,7 @@ ], "source": { "path": "src/plugins/data/public/types.ts", - "lineNumber": 85 + "lineNumber": 77 }, "signature": [ "{ getQuerySuggestions: ", @@ -14689,7 +14719,7 @@ ], "source": { "path": "src/plugins/data/public/types.ts", - "lineNumber": 90 + "lineNumber": 82 }, "signature": [ "Pick<", @@ -14713,7 +14743,7 @@ ], "source": { "path": "src/plugins/data/public/types.ts", - "lineNumber": 95 + "lineNumber": 87 }, "signature": [ { @@ -14735,7 +14765,7 @@ ], "source": { "path": "src/plugins/data/public/types.ts", - "lineNumber": 100 + "lineNumber": 92 }, "signature": [ { @@ -14757,7 +14787,7 @@ ], "source": { "path": "src/plugins/data/public/types.ts", - "lineNumber": 105 + "lineNumber": 97 }, "signature": [ "{ addToQueryLog: (appName: string, { language, query }: ", @@ -14800,7 +14830,7 @@ ], "source": { "path": "src/plugins/data/public/types.ts", - "lineNumber": 110 + "lineNumber": 102 }, "signature": [ { @@ -14820,7 +14850,7 @@ "description": [], "source": { "path": "src/plugins/data/public/types.ts", - "lineNumber": 112 + "lineNumber": 104 }, "signature": [ "Pick>" @@ -20642,7 +20695,7 @@ "tags": [], "description": [], "source": { - "path": "src/plugins/data/common/search/es_search/types.ts", + "path": "src/plugins/data/common/search/strategies/es_search/types.ts", "lineNumber": 22 }, "signature": [ @@ -21815,7 +21868,7 @@ "description": [], "source": { "path": "src/plugins/data/server/index.ts", - "lineNumber": 246 + "lineNumber": 245 }, "signature": [ "typeof ", @@ -21836,7 +21889,7 @@ "description": [], "source": { "path": "src/plugins/data/server/index.ts", - "lineNumber": 247 + "lineNumber": 246 }, "signature": [ "typeof ", @@ -21857,7 +21910,7 @@ "description": [], "source": { "path": "src/plugins/data/server/index.ts", - "lineNumber": 248 + "lineNumber": 247 }, "signature": [ "({ display: string; val: string; enabled(agg: ", @@ -21879,7 +21932,7 @@ "description": [], "source": { "path": "src/plugins/data/server/index.ts", - "lineNumber": 249 + "lineNumber": 248 }, "signature": [ "typeof ", @@ -21900,7 +21953,7 @@ "description": [], "source": { "path": "src/plugins/data/server/index.ts", - "lineNumber": 250 + "lineNumber": 249 }, "signature": [ "typeof ", @@ -21921,7 +21974,7 @@ "description": [], "source": { "path": "src/plugins/data/server/index.ts", - "lineNumber": 251 + "lineNumber": 250 }, "signature": [ "typeof ", @@ -21942,7 +21995,7 @@ "description": [], "source": { "path": "src/plugins/data/server/index.ts", - "lineNumber": 252 + "lineNumber": 251 }, "signature": [ "(agg: ", @@ -21964,7 +22017,7 @@ "description": [], "source": { "path": "src/plugins/data/server/index.ts", - "lineNumber": 253 + "lineNumber": 252 }, "signature": [ "(agg: ", @@ -21986,7 +22039,7 @@ "description": [], "source": { "path": "src/plugins/data/server/index.ts", - "lineNumber": 254 + "lineNumber": 253 }, "signature": [ "(...types: string[]) => (agg: ", @@ -22008,7 +22061,7 @@ "description": [], "source": { "path": "src/plugins/data/server/index.ts", - "lineNumber": 255 + "lineNumber": 254 }, "signature": [ "typeof ", @@ -22029,7 +22082,7 @@ "description": [], "source": { "path": "src/plugins/data/server/index.ts", - "lineNumber": 256 + "lineNumber": 255 }, "signature": [ "typeof ", @@ -22050,7 +22103,7 @@ "description": [], "source": { "path": "src/plugins/data/server/index.ts", - "lineNumber": 257 + "lineNumber": 256 } }, { @@ -22061,7 +22114,7 @@ "description": [], "source": { "path": "src/plugins/data/server/index.ts", - "lineNumber": 258 + "lineNumber": 257 }, "signature": [ "typeof ", @@ -22082,7 +22135,7 @@ "description": [], "source": { "path": "src/plugins/data/server/index.ts", - "lineNumber": 259 + "lineNumber": 258 }, "signature": [ "typeof ", @@ -22103,7 +22156,7 @@ "description": [], "source": { "path": "src/plugins/data/server/index.ts", - "lineNumber": 260 + "lineNumber": 259 }, "signature": [ "typeof ", @@ -22124,7 +22177,7 @@ "description": [], "source": { "path": "src/plugins/data/server/index.ts", - "lineNumber": 261 + "lineNumber": 260 } }, { @@ -22135,7 +22188,7 @@ "description": [], "source": { "path": "src/plugins/data/server/index.ts", - "lineNumber": 262 + "lineNumber": 261 }, "signature": [ "string[]" @@ -22149,7 +22202,7 @@ "description": [], "source": { "path": "src/plugins/data/server/index.ts", - "lineNumber": 263 + "lineNumber": 262 }, "signature": [ "typeof ", @@ -22170,7 +22223,7 @@ "description": [], "source": { "path": "src/plugins/data/server/index.ts", - "lineNumber": 264 + "lineNumber": 263 }, "signature": [ "typeof ", @@ -22188,51 +22241,9 @@ "label": "aggs", "source": { "path": "src/plugins/data/server/index.ts", - "lineNumber": 245 + "lineNumber": 244 } }, - { - "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" - } - ] - }, { "tags": [], "id": "def-server.search.tabifyAggResponse", @@ -22241,7 +22252,7 @@ "description": [], "source": { "path": "src/plugins/data/server/index.ts", - "lineNumber": 268 + "lineNumber": 265 }, "signature": [ "typeof ", @@ -22262,7 +22273,7 @@ "description": [], "source": { "path": "src/plugins/data/server/index.ts", - "lineNumber": 269 + "lineNumber": 266 }, "signature": [ "typeof ", @@ -22280,7 +22291,7 @@ "label": "search", "source": { "path": "src/plugins/data/server/index.ts", - "lineNumber": 244 + "lineNumber": 243 }, "initialIsOpen": false }, diff --git a/api_docs/data_enhanced.json b/api_docs/data_enhanced.json index 6ba0ca8191d10..255607a888033 100644 --- a/api_docs/data_enhanced.json +++ b/api_docs/data_enhanced.json @@ -13,8 +13,8 @@ "label": "ENHANCED_ES_SEARCH_STRATEGY", "description": [], "source": { - "path": "x-pack/plugins/data_enhanced/common/search/types.ts", - "lineNumber": 17 + "path": "src/plugins/data/common/search/strategies/ese_search/types.ts", + "lineNumber": 11 }, "signature": [ "\"ese\"" @@ -28,8 +28,8 @@ "label": "EQL_SEARCH_STRATEGY", "description": [], "source": { - "path": "x-pack/plugins/data_enhanced/common/search/types.ts", - "lineNumber": 19 + "path": "src/plugins/data/common/search/strategies/eql_search/types.ts", + "lineNumber": 14 }, "signature": [ "\"eql\"" @@ -46,7 +46,7 @@ "description": [], "source": { "path": "x-pack/plugins/data_enhanced/public/plugin.ts", - "lineNumber": 38 + "lineNumber": 37 }, "signature": [ "void" @@ -108,12 +108,12 @@ "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 } } ], @@ -121,7 +121,7 @@ "returnComment": [], "source": { "path": "x-pack/plugins/data_enhanced/server/plugin.ts", - "lineNumber": 33 + "lineNumber": 26 } }, { @@ -165,7 +165,7 @@ "description": [], "source": { "path": "x-pack/plugins/data_enhanced/server/plugin.ts", - "lineNumber": 38 + "lineNumber": 31 } }, { @@ -179,7 +179,7 @@ "description": [], "source": { "path": "x-pack/plugins/data_enhanced/server/plugin.ts", - "lineNumber": 38 + "lineNumber": 31 } } ], @@ -187,7 +187,7 @@ "returnComment": [], "source": { "path": "x-pack/plugins/data_enhanced/server/plugin.ts", - "lineNumber": 38 + "lineNumber": 31 } }, { @@ -226,7 +226,7 @@ "description": [], "source": { "path": "x-pack/plugins/data_enhanced/server/plugin.ts", - "lineNumber": 80 + "lineNumber": 54 } }, { @@ -240,7 +240,7 @@ "description": [], "source": { "path": "x-pack/plugins/data_enhanced/server/plugin.ts", - "lineNumber": 80 + "lineNumber": 54 } } ], @@ -248,7 +248,7 @@ "returnComment": [], "source": { "path": "x-pack/plugins/data_enhanced/server/plugin.ts", - "lineNumber": 80 + "lineNumber": 54 } }, { @@ -264,13 +264,13 @@ "returnComment": [], "source": { "path": "x-pack/plugins/data_enhanced/server/plugin.ts", - "lineNumber": 86 + "lineNumber": 60 } } ], "source": { "path": "x-pack/plugins/data_enhanced/server/plugin.ts", - "lineNumber": 27 + "lineNumber": 20 }, "initialIsOpen": false } @@ -286,8 +286,8 @@ "label": "ENHANCED_ES_SEARCH_STRATEGY", "description": [], "source": { - "path": "x-pack/plugins/data_enhanced/common/search/types.ts", - "lineNumber": 17 + "path": "src/plugins/data/common/search/strategies/ese_search/types.ts", + "lineNumber": 11 }, "signature": [ "\"ese\"" @@ -301,8 +301,8 @@ "label": "EQL_SEARCH_STRATEGY", "description": [], "source": { - "path": "x-pack/plugins/data_enhanced/common/search/types.ts", - "lineNumber": 19 + "path": "src/plugins/data/common/search/strategies/eql_search/types.ts", + "lineNumber": 14 }, "signature": [ "\"eql\"" @@ -314,619 +314,10 @@ }, "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 - }, - "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", - "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 - }, - "signature": [ - "\"search-session\"" - ], - "initialIsOpen": false - } - ], + "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_query.json b/api_docs/data_query.json index b9fa69bd66b22..c525710048c15 100644 --- a/api_docs/data_query.json +++ b/api_docs/data_query.json @@ -889,7 +889,7 @@ "description": [], "source": { "path": "src/plugins/data/public/query/saved_query/saved_query_service.ts", - "lineNumber": 21 + "lineNumber": 22 } } ], @@ -915,7 +915,7 @@ "label": "createSavedQueryService", "source": { "path": "src/plugins/data/public/query/saved_query/saved_query_service.ts", - "lineNumber": 20 + "lineNumber": 21 }, "tags": [], "returnComment": [], diff --git a/api_docs/data_search.json b/api_docs/data_search.json index b50d6d267d3f8..565f6b087590f 100644 --- a/api_docs/data_search.json +++ b/api_docs/data_search.json @@ -70,7 +70,13 @@ "label": "err", "isRequired": true, "signature": [ - "IEsError" + { + "pluginId": "data", + "scope": "public", + "docId": "kibDataSearchPluginApi", + "section": "def-public.IEsError", + "text": "IEsError" + } ], "description": [], "source": { @@ -191,143 +197,32 @@ ], "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 } } ], "tags": [], "returnComment": [], "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 } }, { - "id": "def-public.SearchInterceptor.getTimeoutMode", + "id": "def-public.SearchInterceptor.stop", "type": "Function", - "label": "getTimeoutMode", + "label": "stop", "signature": [ - "() => ", - { - "pluginId": "data", - "scope": "public", - "docId": "kibDataSearchPluginApi", - "section": "def-public.TimeoutErrorMode", - "text": "TimeoutErrorMode" - } + "() => void" ], "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" - ], - "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 - } - } - ], - "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 } }, { @@ -335,7 +230,7 @@ "type": "Function", "label": "search", "signature": [ - "(request: ", + "({ id, ...request }: ", { "pluginId": "data", "scope": "common", @@ -348,8 +243,8 @@ "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", - "section": "def-common.ISearchOptions", - "text": "ISearchOptions" + "section": "def-common.IAsyncSearchOptions", + "text": "IAsyncSearchOptions" }, ") => ", "Observable", @@ -370,7 +265,7 @@ { "id": "def-public.SearchInterceptor.search.$1", "type": "Object", - "label": "request", + "label": "{ id, ...request }", "isRequired": true, "signature": [ { @@ -384,8 +279,8 @@ ], "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 } }, { @@ -398,14 +293,14 @@ "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 } } ], @@ -416,8 +311,8 @@ "`Observable` emitting the search response or an error." ], "source": { - "path": "src/plugins/data/public/search/search_interceptor.ts", - "lineNumber": 182 + "path": "src/plugins/data/public/search/search_interceptor/search_interceptor.ts", + "lineNumber": 313 } }, { @@ -439,22 +334,22 @@ ], "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 } } ], "tags": [], "returnComment": [], "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 } } ], "source": { - "path": "src/plugins/data/public/search/search_interceptor.ts", - "lineNumber": 46 + "path": "src/plugins/data/public/search/search_interceptor/search_interceptor.ts", + "lineNumber": 67 }, "initialIsOpen": false }, @@ -492,7 +387,7 @@ "description": [], "source": { "path": "src/plugins/data/public/search/errors/timeout_error.tsx", - "lineNumber": 26 + "lineNumber": 25 }, "signature": [ { @@ -524,7 +419,7 @@ "description": [], "source": { "path": "src/plugins/data/public/search/errors/timeout_error.tsx", - "lineNumber": 27 + "lineNumber": 26 } }, { @@ -544,7 +439,7 @@ "description": [], "source": { "path": "src/plugins/data/public/search/errors/timeout_error.tsx", - "lineNumber": 27 + "lineNumber": 26 } } ], @@ -552,7 +447,7 @@ "returnComment": [], "source": { "path": "src/plugins/data/public/search/errors/timeout_error.tsx", - "lineNumber": 27 + "lineNumber": 26 } }, { @@ -589,7 +484,7 @@ "description": [], "source": { "path": "src/plugins/data/public/search/errors/timeout_error.tsx", - "lineNumber": 80 + "lineNumber": 66 } } ], @@ -597,13 +492,13 @@ "returnComment": [], "source": { "path": "src/plugins/data/public/search/errors/timeout_error.tsx", - "lineNumber": 80 + "lineNumber": 66 } } ], "source": { "path": "src/plugins/data/public/search/errors/timeout_error.tsx", - "lineNumber": 25 + "lineNumber": 24 }, "initialIsOpen": false } @@ -669,6 +564,40 @@ }, "initialIsOpen": false }, + { + "id": "def-public.isEsError", + "type": "Function", + "label": "isEsError", + "signature": [ + "(e: any) => boolean" + ], + "description": [ + "\nChecks if a given errors originated from Elasticsearch.\nThose params are assigned to the attributes property of an error.\n" + ], + "children": [ + { + "id": "def-public.isEsError.$1", + "type": "Any", + "label": "e", + "isRequired": true, + "signature": [ + "any" + ], + "description": [], + "source": { + "path": "src/plugins/data/public/search/errors/types.ts", + "lineNumber": 51 + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/public/search/errors/types.ts", + "lineNumber": 51 + }, + "initialIsOpen": false + }, { "id": "def-public.waitUntilNextSessionCompletes$", "type": "Function", @@ -766,7 +695,7 @@ "description": [], "source": { "path": "src/plugins/data/public/search/types.ts", - "lineNumber": 29 + "lineNumber": 24 }, "signature": [ "AggsCommonSetup" @@ -780,7 +709,7 @@ "description": [], "source": { "path": "src/plugins/data/public/search/types.ts", - "lineNumber": 30 + "lineNumber": 25 }, "signature": [ "SearchUsageCollector", @@ -797,7 +726,7 @@ ], "source": { "path": "src/plugins/data/public/search/types.ts", - "lineNumber": 35 + "lineNumber": 30 }, "signature": [ "Pick<", @@ -815,7 +744,7 @@ ], "source": { "path": "src/plugins/data/public/search/types.ts", - "lineNumber": 40 + "lineNumber": 35 }, "signature": [ "Pick<", @@ -826,7 +755,7 @@ ], "source": { "path": "src/plugins/data/public/search/types.ts", - "lineNumber": 28 + "lineNumber": 23 }, "initialIsOpen": false }, @@ -851,7 +780,7 @@ ], "source": { "path": "src/plugins/data/public/search/types.ts", - "lineNumber": 57 + "lineNumber": 48 }, "signature": [ "Pick void" @@ -909,7 +838,7 @@ ], "source": { "path": "src/plugins/data/public/search/types.ts", - "lineNumber": 69 + "lineNumber": 60 }, "signature": [ { @@ -931,7 +860,7 @@ ], "source": { "path": "src/plugins/data/public/search/types.ts", - "lineNumber": 74 + "lineNumber": 65 }, "signature": [ "Pick<", @@ -949,7 +878,7 @@ ], "source": { "path": "src/plugins/data/public/search/types.ts", - "lineNumber": 79 + "lineNumber": 70 }, "signature": [ "Pick<", @@ -960,7 +889,113 @@ ], "source": { "path": "src/plugins/data/public/search/types.ts", - "lineNumber": 51 + "lineNumber": 42 + }, + "initialIsOpen": false + }, + { + "id": "def-public.Reason", + "type": "Interface", + "label": "Reason", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-public.Reason.type", + "type": "string", + "label": "type", + "description": [], + "source": { + "path": "src/plugins/data/public/search/errors/types.ts", + "lineNumber": 19 + } + }, + { + "tags": [], + "id": "def-public.Reason.reason", + "type": "string", + "label": "reason", + "description": [], + "source": { + "path": "src/plugins/data/public/search/errors/types.ts", + "lineNumber": 20 + } + }, + { + "tags": [], + "id": "def-public.Reason.script_stack", + "type": "Array", + "label": "script_stack", + "description": [], + "source": { + "path": "src/plugins/data/public/search/errors/types.ts", + "lineNumber": 21 + }, + "signature": [ + "string[] | undefined" + ] + }, + { + "tags": [], + "id": "def-public.Reason.position", + "type": "Object", + "label": "position", + "description": [], + "source": { + "path": "src/plugins/data/public/search/errors/types.ts", + "lineNumber": 22 + }, + "signature": [ + "{ offset: number; start: number; end: number; } | undefined" + ] + }, + { + "tags": [], + "id": "def-public.Reason.lang", + "type": "string", + "label": "lang", + "description": [], + "source": { + "path": "src/plugins/data/public/search/errors/types.ts", + "lineNumber": 27 + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [], + "id": "def-public.Reason.script", + "type": "string", + "label": "script", + "description": [], + "source": { + "path": "src/plugins/data/public/search/errors/types.ts", + "lineNumber": 28 + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [], + "id": "def-public.Reason.caused_by", + "type": "Object", + "label": "caused_by", + "description": [], + "source": { + "path": "src/plugins/data/public/search/errors/types.ts", + "lineNumber": 29 + }, + "signature": [ + "{ type: string; reason: string; } | undefined" + ] + } + ], + "source": { + "path": "src/plugins/data/public/search/errors/types.ts", + "lineNumber": 18 }, "initialIsOpen": false }, @@ -978,8 +1013,8 @@ "label": "bfetch", "description": [], "source": { - "path": "src/plugins/data/public/search/search_interceptor.ts", - "lineNumber": 37 + "path": "src/plugins/data/public/search/search_interceptor/search_interceptor.ts", + "lineNumber": 55 }, "signature": [ { @@ -998,8 +1033,8 @@ "label": "http", "description": [], "source": { - "path": "src/plugins/data/public/search/search_interceptor.ts", - "lineNumber": 38 + "path": "src/plugins/data/public/search/search_interceptor/search_interceptor.ts", + "lineNumber": 56 }, "signature": [ { @@ -1018,8 +1053,8 @@ "label": "uiSettings", "description": [], "source": { - "path": "src/plugins/data/public/search/search_interceptor.ts", - "lineNumber": 39 + "path": "src/plugins/data/public/search/search_interceptor/search_interceptor.ts", + "lineNumber": 57 }, "signature": [ { @@ -1038,8 +1073,8 @@ "label": "startServices", "description": [], "source": { - "path": "src/plugins/data/public/search/search_interceptor.ts", - "lineNumber": 40 + "path": "src/plugins/data/public/search/search_interceptor/search_interceptor.ts", + "lineNumber": 58 }, "signature": [ "Promise<[", @@ -1060,8 +1095,8 @@ "label": "toasts", "description": [], "source": { - "path": "src/plugins/data/public/search/search_interceptor.ts", - "lineNumber": 41 + "path": "src/plugins/data/public/search/search_interceptor/search_interceptor.ts", + "lineNumber": 59 }, "signature": [ "Pick<", @@ -1082,8 +1117,8 @@ "label": "usageCollector", "description": [], "source": { - "path": "src/plugins/data/public/search/search_interceptor.ts", - "lineNumber": 42 + "path": "src/plugins/data/public/search/search_interceptor/search_interceptor.ts", + "lineNumber": 60 }, "signature": [ "SearchUsageCollector", @@ -1097,8 +1132,8 @@ "label": "session", "description": [], "source": { - "path": "src/plugins/data/public/search/search_interceptor.ts", - "lineNumber": 43 + "path": "src/plugins/data/public/search/search_interceptor/search_interceptor.ts", + "lineNumber": 61 }, "signature": [ "Pick<", @@ -1108,8 +1143,8 @@ } ], "source": { - "path": "src/plugins/data/public/search/search_interceptor.ts", - "lineNumber": 36 + "path": "src/plugins/data/public/search/search_interceptor/search_interceptor.ts", + "lineNumber": 54 }, "initialIsOpen": false }, @@ -1265,6 +1300,21 @@ } ], "misc": [ + { + "id": "def-public.IEsError", + "type": "Type", + "label": "IEsError", + "tags": [], + "description": [], + "source": { + "path": "src/plugins/data/public/search/errors/types.ts", + "lineNumber": 43 + }, + "signature": [ + "KibanaServerError" + ], + "initialIsOpen": false + }, { "id": "def-public.ISessionsClient", "type": "Type", @@ -1276,7 +1326,7 @@ "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>; }" + "{ 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>; }" ], "initialIsOpen": false }, @@ -1367,7 +1417,7 @@ ], "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 } } @@ -1375,7 +1425,7 @@ "tags": [], "returnComment": [], "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": 19 }, "initialIsOpen": false @@ -1414,7 +1464,7 @@ ], "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 } } @@ -1422,7 +1472,7 @@ "tags": [], "returnComment": [], "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 }, "initialIsOpen": false @@ -1584,6 +1634,160 @@ } ], "interfaces": [ + { + "id": "def-server.AsyncSearchResponse", + "type": "Interface", + "label": "AsyncSearchResponse", + "signature": [ + { + "pluginId": "data", + "scope": "server", + "docId": "kibDataSearchPluginApi", + "section": "def-server.AsyncSearchResponse", + "text": "AsyncSearchResponse" + }, + "" + ], + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-server.AsyncSearchResponse.id", + "type": "string", + "label": "id", + "description": [], + "source": { + "path": "src/plugins/data/server/search/strategies/ese_search/types.ts", + "lineNumber": 13 + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [], + "id": "def-server.AsyncSearchResponse.response", + "type": "Object", + "label": "response", + "description": [], + "source": { + "path": "src/plugins/data/server/search/strategies/ese_search/types.ts", + "lineNumber": 14 + }, + "signature": [ + "SearchResponse", + "" + ] + }, + { + "tags": [], + "id": "def-server.AsyncSearchResponse.start_time_in_millis", + "type": "number", + "label": "start_time_in_millis", + "description": [], + "source": { + "path": "src/plugins/data/server/search/strategies/ese_search/types.ts", + "lineNumber": 15 + } + }, + { + "tags": [], + "id": "def-server.AsyncSearchResponse.expiration_time_in_millis", + "type": "number", + "label": "expiration_time_in_millis", + "description": [], + "source": { + "path": "src/plugins/data/server/search/strategies/ese_search/types.ts", + "lineNumber": 16 + } + }, + { + "tags": [], + "id": "def-server.AsyncSearchResponse.is_partial", + "type": "boolean", + "label": "is_partial", + "description": [], + "source": { + "path": "src/plugins/data/server/search/strategies/ese_search/types.ts", + "lineNumber": 17 + } + }, + { + "tags": [], + "id": "def-server.AsyncSearchResponse.is_running", + "type": "boolean", + "label": "is_running", + "description": [], + "source": { + "path": "src/plugins/data/server/search/strategies/ese_search/types.ts", + "lineNumber": 18 + } + } + ], + "source": { + "path": "src/plugins/data/server/search/strategies/ese_search/types.ts", + "lineNumber": 12 + }, + "initialIsOpen": false + }, + { + "id": "def-server.AsyncSearchStatusResponse", + "type": "Interface", + "label": "AsyncSearchStatusResponse", + "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\">" + ], + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-server.AsyncSearchStatusResponse.completion_status", + "type": "number", + "label": "completion_status", + "description": [], + "source": { + "path": "src/plugins/data/server/search/strategies/ese_search/types.ts", + "lineNumber": 21 + } + }, + { + "tags": [], + "id": "def-server.AsyncSearchStatusResponse._shards", + "type": "Object", + "label": "_shards", + "description": [], + "source": { + "path": "src/plugins/data/server/search/strategies/ese_search/types.ts", + "lineNumber": 22 + }, + "signature": [ + "ShardsResponse" + ] + } + ], + "source": { + "path": "src/plugins/data/server/search/strategies/ese_search/types.ts", + "lineNumber": 20 + }, + "initialIsOpen": false + }, { "id": "def-server.IScopedSearchClient", "type": "Interface", @@ -1659,7 +1863,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,7 +1871,7 @@ "section": "def-server.SavedObjectsFindResponse", "text": "SavedObjectsFindResponse" }, - ">" + ">" ] }, { @@ -1774,7 +1978,7 @@ "description": [], "source": { "path": "src/plugins/data/server/search/session/types.ts", - "lineNumber": 37 + "lineNumber": 39 }, "signature": [ "(core: ", @@ -1801,7 +2005,7 @@ ], "source": { "path": "src/plugins/data/server/search/session/types.ts", - "lineNumber": 36 + "lineNumber": 38 }, "initialIsOpen": false }, @@ -3423,7 +3627,7 @@ "description": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_configs.ts", - "lineNumber": 65 + "lineNumber": 66 }, "signature": [ { @@ -3443,7 +3647,7 @@ "description": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_configs.ts", - "lineNumber": 66 + "lineNumber": 67 }, "signature": [ { @@ -3464,12 +3668,26 @@ "description": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_configs.ts", - "lineNumber": 67 + "lineNumber": 68 }, "signature": [ "string[] | undefined" ] }, + { + "tags": [], + "id": "def-common.AggConfigs.hierarchical", + "type": "CompoundType", + "label": "hierarchical", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_configs.ts", + "lineNumber": 69 + }, + "signature": [ + "boolean | undefined" + ] + }, { "tags": [], "id": "def-common.AggConfigs.aggs", @@ -3478,7 +3696,7 @@ "description": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_configs.ts", - "lineNumber": 70 + "lineNumber": 73 }, "signature": [ { @@ -3517,7 +3735,7 @@ "description": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_configs.ts", - "lineNumber": 73 + "lineNumber": 76 } }, { @@ -3549,7 +3767,7 @@ "description": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_configs.ts", - "lineNumber": 74 + "lineNumber": 77 } }, { @@ -3569,7 +3787,7 @@ "description": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_configs.ts", - "lineNumber": 75 + "lineNumber": 78 } } ], @@ -3577,7 +3795,7 @@ "returnComment": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_configs.ts", - "lineNumber": 72 + "lineNumber": 75 } }, { @@ -3600,7 +3818,7 @@ "description": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_configs.ts", - "lineNumber": 87 + "lineNumber": 91 } } ], @@ -3608,7 +3826,7 @@ "returnComment": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_configs.ts", - "lineNumber": 87 + "lineNumber": 91 } }, { @@ -3645,7 +3863,7 @@ "description": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_configs.ts", - "lineNumber": 91 + "lineNumber": 95 } } ], @@ -3653,7 +3871,7 @@ "returnComment": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_configs.ts", - "lineNumber": 91 + "lineNumber": 95 } }, { @@ -3683,7 +3901,7 @@ "description": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_configs.ts", - "lineNumber": 109 + "lineNumber": 113 } } ], @@ -3691,7 +3909,7 @@ "returnComment": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_configs.ts", - "lineNumber": 109 + "lineNumber": 113 } }, { @@ -3727,7 +3945,7 @@ "description": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_configs.ts", - "lineNumber": 123 + "lineNumber": 127 } }, { @@ -3741,7 +3959,7 @@ "description": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_configs.ts", - "lineNumber": 124 + "lineNumber": 128 } } ], @@ -3785,7 +4003,7 @@ "label": "createAggConfig", "source": { "path": "src/plugins/data/common/search/aggs/agg_configs.ts", - "lineNumber": 122 + "lineNumber": 126 }, "tags": [], "returnComment": [] @@ -3829,7 +4047,7 @@ ], "source": { "path": "src/plugins/data/common/search/aggs/agg_configs.ts", - "lineNumber": 165 + "lineNumber": 169 } } ], @@ -3837,38 +4055,23 @@ "returnComment": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_configs.ts", - "lineNumber": 165 + "lineNumber": 169 } }, { "id": "def-common.AggConfigs.toDsl", "type": "Function", "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" ], + "description": [], + "children": [], "tags": [], "returnComment": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_configs.ts", - "lineNumber": 177 + "lineNumber": 181 } }, { @@ -3892,7 +4095,7 @@ "returnComment": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_configs.ts", - "lineNumber": 246 + "lineNumber": 250 } }, { @@ -3922,7 +4125,7 @@ "description": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_configs.ts", - "lineNumber": 250 + "lineNumber": 254 } } ], @@ -3930,7 +4133,7 @@ "returnComment": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_configs.ts", - "lineNumber": 250 + "lineNumber": 254 } }, { @@ -3961,7 +4164,7 @@ "description": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_configs.ts", - "lineNumber": 254 + "lineNumber": 258 } } ], @@ -3969,7 +4172,7 @@ "returnComment": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_configs.ts", - "lineNumber": 254 + "lineNumber": 258 } }, { @@ -4000,7 +4203,7 @@ "description": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_configs.ts", - "lineNumber": 258 + "lineNumber": 262 } } ], @@ -4008,7 +4211,7 @@ "returnComment": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_configs.ts", - "lineNumber": 258 + "lineNumber": 262 } }, { @@ -4039,7 +4242,7 @@ "description": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_configs.ts", - "lineNumber": 262 + "lineNumber": 266 } } ], @@ -4047,7 +4250,7 @@ "returnComment": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_configs.ts", - "lineNumber": 262 + "lineNumber": 266 } }, { @@ -4078,7 +4281,7 @@ "description": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_configs.ts", - "lineNumber": 266 + "lineNumber": 270 } } ], @@ -4086,7 +4289,7 @@ "returnComment": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_configs.ts", - "lineNumber": 266 + "lineNumber": 270 } }, { @@ -4117,7 +4320,7 @@ "description": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_configs.ts", - "lineNumber": 270 + "lineNumber": 274 } } ], @@ -4125,7 +4328,7 @@ "returnComment": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_configs.ts", - "lineNumber": 270 + "lineNumber": 274 } }, { @@ -4149,7 +4352,7 @@ "returnComment": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_configs.ts", - "lineNumber": 274 + "lineNumber": 278 } }, { @@ -4180,7 +4383,7 @@ "description": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_configs.ts", - "lineNumber": 288 + "lineNumber": 292 } } ], @@ -4188,7 +4391,7 @@ "returnComment": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_configs.ts", - "lineNumber": 288 + "lineNumber": 292 } }, { @@ -4216,7 +4419,7 @@ "returnComment": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_configs.ts", - "lineNumber": 303 + "lineNumber": 307 } }, { @@ -4251,7 +4454,7 @@ ], "source": { "path": "src/plugins/data/common/search/aggs/agg_configs.ts", - "lineNumber": 317 + "lineNumber": 321 } } ], @@ -4261,7 +4464,7 @@ "returnComment": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_configs.ts", - "lineNumber": 317 + "lineNumber": 321 } }, { @@ -4308,7 +4511,7 @@ "description": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_configs.ts", - "lineNumber": 326 + "lineNumber": 330 } }, { @@ -4329,7 +4532,7 @@ "description": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_configs.ts", - "lineNumber": 326 + "lineNumber": 330 } } ], @@ -4337,13 +4540,13 @@ "returnComment": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_configs.ts", - "lineNumber": 326 + "lineNumber": 330 } } ], "source": { "path": "src/plugins/data/common/search/aggs/agg_configs.ts", - "lineNumber": 64 + "lineNumber": 65 }, "initialIsOpen": false }, @@ -4554,7 +4757,7 @@ ], "source": { "path": "src/plugins/data/common/search/aggs/agg_type.ts", - "lineNumber": 71 + "lineNumber": 74 } }, { @@ -4565,7 +4768,7 @@ "description": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_type.ts", - "lineNumber": 73 + "lineNumber": 76 } }, { @@ -4576,7 +4779,7 @@ "description": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_type.ts", - "lineNumber": 74 + "lineNumber": 77 }, "signature": [ "string | undefined" @@ -4595,7 +4798,7 @@ ], "source": { "path": "src/plugins/data/common/search/aggs/agg_type.ts", - "lineNumber": 81 + "lineNumber": 84 } }, { @@ -4611,7 +4814,7 @@ ], "source": { "path": "src/plugins/data/common/search/aggs/agg_type.ts", - "lineNumber": 88 + "lineNumber": 91 } }, { @@ -4627,7 +4830,7 @@ ], "source": { "path": "src/plugins/data/common/search/aggs/agg_type.ts", - "lineNumber": 95 + "lineNumber": 98 } }, { @@ -4640,10 +4843,10 @@ ], "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" + "\"string\" | \"number\" | \"boolean\" | \"object\" | \"date\" | \"ip\" | \"unknown\" | \"_source\" | \"attachment\" | \"geo_point\" | \"geo_shape\" | \"murmur3\" | \"conflict\" | \"nested\" | \"histogram\" | \"null\" | undefined" ] }, { @@ -4658,7 +4861,7 @@ ], "source": { "path": "src/plugins/data/common/search/aggs/agg_type.ts", - "lineNumber": 109 + "lineNumber": 112 }, "signature": [ "((aggConfig: TAggConfig) => string) | (() => string)" @@ -4677,7 +4880,7 @@ ], "source": { "path": "src/plugins/data/common/search/aggs/agg_type.ts", - "lineNumber": 124 + "lineNumber": 127 }, "signature": [ "any" @@ -4695,7 +4898,7 @@ ], "source": { "path": "src/plugins/data/common/search/aggs/agg_type.ts", - "lineNumber": 132 + "lineNumber": 135 } }, { @@ -4710,7 +4913,7 @@ ], "source": { "path": "src/plugins/data/common/search/aggs/agg_type.ts", - "lineNumber": 138 + "lineNumber": 141 } }, { @@ -4723,7 +4926,7 @@ ], "source": { "path": "src/plugins/data/common/search/aggs/agg_type.ts", - "lineNumber": 145 + "lineNumber": 148 }, "signature": [ "((aggConfig: TAggConfig, key: any, params?: any) => any) | undefined" @@ -4742,7 +4945,7 @@ ], "source": { "path": "src/plugins/data/common/search/aggs/agg_type.ts", - "lineNumber": 152 + "lineNumber": 155 }, "signature": [ "TParam[]" @@ -4760,7 +4963,7 @@ ], "source": { "path": "src/plugins/data/common/search/aggs/agg_type.ts", - "lineNumber": 162 + "lineNumber": 165 }, "signature": [ "((aggConfig: TAggConfig) => TAggConfig[]) | (() => void | TAggConfig[])" @@ -4778,7 +4981,7 @@ ], "source": { "path": "src/plugins/data/common/search/aggs/agg_type.ts", - "lineNumber": 173 + "lineNumber": 176 }, "signature": [ "((aggConfig: TAggConfig) => TAggConfig[]) | (() => void | TAggConfig[])" @@ -4794,7 +4997,7 @@ ], "source": { "path": "src/plugins/data/common/search/aggs/agg_type.ts", - "lineNumber": 178 + "lineNumber": 181 }, "signature": [ "() => any" @@ -4812,34 +5015,10 @@ ], "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" + "PostFlightRequestFn" ] }, { @@ -4854,7 +5033,7 @@ ], "source": { "path": "src/plugins/data/common/search/aggs/agg_type.ts", - "lineNumber": 209 + "lineNumber": 204 }, "signature": [ "(agg: TAggConfig) => ", @@ -4876,7 +5055,7 @@ "description": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_type.ts", - "lineNumber": 211 + "lineNumber": 206 }, "signature": [ "(agg: TAggConfig, bucket: any) => any" @@ -4890,7 +5069,7 @@ "description": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_type.ts", - "lineNumber": 213 + "lineNumber": 208 }, "signature": [ "((bucket: any, key: any, agg: TAggConfig) => any) | undefined" @@ -4911,7 +5090,7 @@ "description": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_type.ts", - "lineNumber": 215 + "lineNumber": 210 } } ], @@ -4922,7 +5101,7 @@ "label": "paramByName", "source": { "path": "src/plugins/data/common/search/aggs/agg_type.ts", - "lineNumber": 215 + "lineNumber": 210 }, "tags": [], "returnComment": [] @@ -4942,7 +5121,7 @@ "description": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_type.ts", - "lineNumber": 219 + "lineNumber": 214 } } ], @@ -4953,7 +5132,7 @@ "label": "getValueBucketPath", "source": { "path": "src/plugins/data/common/search/aggs/agg_type.ts", - "lineNumber": 219 + "lineNumber": 214 }, "tags": [], "returnComment": [] @@ -4997,7 +5176,7 @@ ], "source": { "path": "src/plugins/data/common/search/aggs/agg_type.ts", - "lineNumber": 232 + "lineNumber": 227 } } ], @@ -5008,13 +5187,13 @@ "returnComment": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_type.ts", - "lineNumber": 232 + "lineNumber": 227 } } ], "source": { "path": "src/plugins/data/common/search/aggs/agg_type.ts", - "lineNumber": 61 + "lineNumber": 64 }, "initialIsOpen": false }, @@ -6275,7 +6454,13 @@ "lineNumber": 19 }, "signature": [ - "SearchResponse", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.IKibanaSearchResponse", + "text": "IKibanaSearchResponse" + }, " | undefined" ] }, @@ -6315,7 +6500,13 @@ "label": "resp", "isRequired": false, "signature": [ - "SearchResponse", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.IKibanaSearchResponse", + "text": "IKibanaSearchResponse" + }, " | undefined" ], "description": [], @@ -6356,7 +6547,7 @@ "description": [], "source": { "path": "src/plugins/data/common/search/search_source/search_source.ts", - "lineNumber": 111 + "lineNumber": 129 }, "signature": [ "Record[]" @@ -6388,7 +6579,7 @@ "description": [], "source": { "path": "src/plugins/data/common/search/search_source/search_source.ts", - "lineNumber": 115 + "lineNumber": 133 } }, { @@ -6408,7 +6599,7 @@ "description": [], "source": { "path": "src/plugins/data/common/search/search_source/search_source.ts", - "lineNumber": 115 + "lineNumber": 133 } } ], @@ -6416,7 +6607,7 @@ "returnComment": [], "source": { "path": "src/plugins/data/common/search/search_source/search_source.ts", - "lineNumber": 115 + "lineNumber": 133 } }, { @@ -6441,7 +6632,7 @@ "description": [], "source": { "path": "src/plugins/data/common/search/search_source/search_source.ts", - "lineNumber": 133 + "lineNumber": 151 } } ], @@ -6449,7 +6640,7 @@ "returnComment": [], "source": { "path": "src/plugins/data/common/search/search_source/search_source.ts", - "lineNumber": 133 + "lineNumber": 151 } }, { @@ -6484,7 +6675,7 @@ ], "source": { "path": "src/plugins/data/common/search/search_source/search_source.ts", - "lineNumber": 142 + "lineNumber": 160 } }, { @@ -6507,7 +6698,7 @@ ], "source": { "path": "src/plugins/data/common/search/search_source/search_source.ts", - "lineNumber": 142 + "lineNumber": 160 } } ], @@ -6515,7 +6706,7 @@ "returnComment": [], "source": { "path": "src/plugins/data/common/search/search_source/search_source.ts", - "lineNumber": 142 + "lineNumber": 160 } }, { @@ -6542,7 +6733,7 @@ ], "source": { "path": "src/plugins/data/common/search/search_source/search_source.ts", - "lineNumber": 154 + "lineNumber": 172 } } ], @@ -6550,7 +6741,7 @@ "returnComment": [], "source": { "path": "src/plugins/data/common/search/search_source/search_source.ts", - "lineNumber": 154 + "lineNumber": 172 } }, { @@ -6591,7 +6782,7 @@ ], "source": { "path": "src/plugins/data/common/search/search_source/search_source.ts", - "lineNumber": 165 + "lineNumber": 183 } } ], @@ -6601,7 +6792,7 @@ "returnComment": [], "source": { "path": "src/plugins/data/common/search/search_source/search_source.ts", - "lineNumber": 165 + "lineNumber": 183 } }, { @@ -6619,7 +6810,7 @@ "returnComment": [], "source": { "path": "src/plugins/data/common/search/search_source/search_source.ts", - "lineNumber": 173 + "lineNumber": 191 } }, { @@ -6644,7 +6835,7 @@ "returnComment": [], "source": { "path": "src/plugins/data/common/search/search_source/search_source.ts", - "lineNumber": 180 + "lineNumber": 198 } }, { @@ -6677,7 +6868,7 @@ "description": [], "source": { "path": "src/plugins/data/common/search/search_source/search_source.ts", - "lineNumber": 187 + "lineNumber": 205 } }, { @@ -6691,7 +6882,7 @@ "description": [], "source": { "path": "src/plugins/data/common/search/search_source/search_source.ts", - "lineNumber": 187 + "lineNumber": 205 } } ], @@ -6699,7 +6890,7 @@ "returnComment": [], "source": { "path": "src/plugins/data/common/search/search_source/search_source.ts", - "lineNumber": 187 + "lineNumber": 205 } }, { @@ -6732,7 +6923,7 @@ "description": [], "source": { "path": "src/plugins/data/common/search/search_source/search_source.ts", - "lineNumber": 198 + "lineNumber": 216 } } ], @@ -6740,7 +6931,7 @@ "returnComment": [], "source": { "path": "src/plugins/data/common/search/search_source/search_source.ts", - "lineNumber": 198 + "lineNumber": 216 } }, { @@ -6765,7 +6956,7 @@ "returnComment": [], "source": { "path": "src/plugins/data/common/search/search_source/search_source.ts", - "lineNumber": 205 + "lineNumber": 223 } }, { @@ -6790,7 +6981,7 @@ "returnComment": [], "source": { "path": "src/plugins/data/common/search/search_source/search_source.ts", - "lineNumber": 212 + "lineNumber": 230 } }, { @@ -6822,7 +7013,7 @@ "description": [], "source": { "path": "src/plugins/data/common/search/search_source/search_source.ts", - "lineNumber": 226 + "lineNumber": 244 } } ], @@ -6830,7 +7021,7 @@ "returnComment": [], "source": { "path": "src/plugins/data/common/search/search_source/search_source.ts", - "lineNumber": 226 + "lineNumber": 244 } }, { @@ -6881,7 +7072,7 @@ ], "source": { "path": "src/plugins/data/common/search/search_source/search_source.ts", - "lineNumber": 238 + "lineNumber": 256 } }, { @@ -6903,7 +7094,7 @@ ], "source": { "path": "src/plugins/data/common/search/search_source/search_source.ts", - "lineNumber": 238 + "lineNumber": 256 } } ], @@ -6915,7 +7106,7 @@ ], "source": { "path": "src/plugins/data/common/search/search_source/search_source.ts", - "lineNumber": 238 + "lineNumber": 256 } }, { @@ -6943,7 +7134,7 @@ "returnComment": [], "source": { "path": "src/plugins/data/common/search/search_source/search_source.ts", - "lineNumber": 248 + "lineNumber": 266 } }, { @@ -6962,8 +7153,16 @@ ") => ", "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)" @@ -6986,7 +7185,7 @@ "description": [], "source": { "path": "src/plugins/data/common/search/search_source/search_source.ts", - "lineNumber": 256 + "lineNumber": 275 } } ], @@ -6994,7 +7193,7 @@ "returnComment": [], "source": { "path": "src/plugins/data/common/search/search_source/search_source.ts", - "lineNumber": 256 + "lineNumber": 274 } }, { @@ -7035,7 +7234,7 @@ "description": [], "source": { "path": "src/plugins/data/common/search/search_source/search_source.ts", - "lineNumber": 283 + "lineNumber": 312 } } ], @@ -7045,7 +7244,7 @@ "returnComment": [], "source": { "path": "src/plugins/data/common/search/search_source/search_source.ts", - "lineNumber": 283 + "lineNumber": 312 } }, { @@ -7102,7 +7301,7 @@ "description": [], "source": { "path": "src/plugins/data/common/search/search_source/search_source.ts", - "lineNumber": 293 + "lineNumber": 326 } } ], @@ -7112,7 +7311,7 @@ "returnComment": [], "source": { "path": "src/plugins/data/common/search/search_source/search_source.ts", - "lineNumber": 292 + "lineNumber": 325 } }, { @@ -7120,7 +7319,7 @@ "type": "Function", "label": "getSearchRequestBody", "signature": [ - "() => Promise" + "() => any" ], "description": [ "\nReturns body contents of the search request, often referred as query DSL." @@ -7130,7 +7329,7 @@ "returnComment": [], "source": { "path": "src/plugins/data/common/search/search_source/search_source.ts", - "lineNumber": 301 + "lineNumber": 334 } }, { @@ -7150,7 +7349,7 @@ "returnComment": [], "source": { "path": "src/plugins/data/common/search/search_source/search_source.ts", - "lineNumber": 310 + "lineNumber": 342 } }, { @@ -7182,7 +7381,7 @@ "description": [], "source": { "path": "src/plugins/data/common/search/search_source/search_source.ts", - "lineNumber": 688 + "lineNumber": 826 } } ], @@ -7190,7 +7389,7 @@ "returnComment": [], "source": { "path": "src/plugins/data/common/search/search_source/search_source.ts", - "lineNumber": 688 + "lineNumber": 826 } }, { @@ -7212,13 +7411,13 @@ "returnComment": [], "source": { "path": "src/plugins/data/common/search/search_source/search_source.ts", - "lineNumber": 717 + "lineNumber": 855 } } ], "source": { "path": "src/plugins/data/common/search/search_source/search_source.ts", - "lineNumber": 103 + "lineNumber": 121 }, "initialIsOpen": false }, @@ -8357,171 +8556,79 @@ "label": "interval", "isRequired": true, "signature": [ - "string" - ], - "description": [ - "The interval string to return the appropriate date_histogram key for." - ], - "source": { - "path": "src/plugins/data/common/search/aggs/utils/date_interval_utils/date_histogram_interval.ts", - "lineNumber": 31 - } - } - ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/data/common/search/aggs/utils/date_interval_utils/date_histogram_interval.ts", - "lineNumber": 31 - }, - "initialIsOpen": false - }, - { - "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 - } - } - ], - "signature": [ - "(state: ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.SearchSourceFields", - "text": "SearchSourceFields" - }, - ") => [", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.SearchSourceFields", - "text": "SearchSourceFields" - }, - " & { indexRefName?: string | undefined; }, ", - "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)." - ], - "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", - "type": "Object", - "label": "options", - "isRequired": true, - "signature": [ - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.ISearchOptions", - "text": "ISearchOptions" - } + "string" + ], + "description": [ + "The interval string to return the appropriate date_histogram key for." ], - "description": [], "source": { - "path": "src/plugins/data/common/search/search_source/legacy/fetch_soon.ts", - "lineNumber": 21 + "path": "src/plugins/data/common/search/aggs/utils/date_interval_utils/date_histogram_interval.ts", + "lineNumber": 31 } - }, + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/common/search/aggs/utils/date_interval_utils/date_histogram_interval.ts", + "lineNumber": 31 + }, + "initialIsOpen": false + }, + { + "id": "def-common.extractReferences", + "type": "Function", + "children": [ { - "id": "def-common.fetchSoon.$3", + "id": "def-common.extractReferences.$1", "type": "Object", - "label": "fetchHandlers", + "label": "state", "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 } } ], - "tags": [], - "returnComment": [], + "signature": [ + "(state: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.SearchSourceFields", + "text": "SearchSourceFields" + }, + ") => [", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.SearchSourceFields", + "text": "SearchSourceFields" + }, + " & { indexRefName?: string | undefined; }, ", + "SavedObjectReference", + "[]]" + ], + "description": [], + "label": "extractReferences", "source": { - "path": "src/plugins/data/common/search/search_source/legacy/fetch_soon.ts", - "lineNumber": 19 + "path": "src/plugins/data/common/search/search_source/extract_references.ts", + "lineNumber": 13 }, + "tags": [], + "returnComment": [], "initialIsOpen": false }, { @@ -10039,63 +10146,6 @@ "returnComment": [], "initialIsOpen": false }, - { - "id": "def-common.getRequestInspectorStats", - "type": "Function", - "label": "getRequestInspectorStats", - "signature": [ - "(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\">) => ", - { - "pluginId": "inspector", - "scope": "common", - "docId": "kibInspectorPluginApi", - "section": "def-common.RequestStatistics", - "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 - }, - "initialIsOpen": false - }, { "id": "def-common.getResponseInspectorStats", "type": "Function", @@ -10103,7 +10153,7 @@ "signature": [ "(resp: ", "SearchResponse", - ", searchSource: Pick<", + " | undefined, searchSource: Pick<", { "pluginId": "data", "scope": "common", @@ -10126,14 +10176,14 @@ "id": "def-common.getResponseInspectorStats.$1", "type": "Object", "label": "resp", - "isRequired": true, + "isRequired": false, "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 } }, @@ -10155,7 +10205,7 @@ ], "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 } } @@ -10165,7 +10215,7 @@ ], "returnComment": [], "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": 52 }, "initialIsOpen": false @@ -10490,7 +10540,7 @@ "label": "getTermsBucketAgg", "source": { "path": "src/plugins/data/common/search/aggs/buckets/terms.ts", - "lineNumber": 65 + "lineNumber": 63 }, "tags": [], "returnComment": [], @@ -10528,7 +10578,7 @@ { "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}", + "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}", "isRequired": true, "signature": [ "RequestHandlerParams" @@ -10536,12 +10586,12 @@ "description": [], "source": { "path": "src/plugins/data/common/search/expressions/esaggs/request_handler.ts", - "lineNumber": 44 + "lineNumber": 43 } } ], "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<", { @@ -10557,7 +10607,7 @@ "label": "handleRequest", "source": { "path": "src/plugins/data/common/search/expressions/esaggs/request_handler.ts", - "lineNumber": 44 + "lineNumber": 43 }, "tags": [], "returnComment": [], @@ -11311,6 +11361,90 @@ "returnComment": [], "initialIsOpen": false }, + { + "id": "def-common.pollSearch", + "type": "Function", + "children": [ + { + "id": "def-common.pollSearch.$1", + "type": "Function", + "label": "search", + "isRequired": true, + "signature": [ + "() => Promise" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/search/poll_search.ts", + "lineNumber": 19 + } + }, + { + "id": "def-common.pollSearch.$2", + "type": "Function", + "label": "cancel", + "isRequired": false, + "signature": [ + "(() => void) | undefined" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/search/poll_search.ts", + "lineNumber": 20 + } + }, + { + "id": "def-common.pollSearch.$3", + "type": "Object", + "label": "{ pollInterval = 1000, abortSignal }", + "isRequired": true, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.IAsyncSearchOptions", + "text": "IAsyncSearchOptions" + } + ], + "description": [], + "source": { + "path": "src/plugins/data/common/search/poll_search.ts", + "lineNumber": 21 + } + } + ], + "signature": [ + ">(search: () => Promise, cancel?: (() => void) | undefined, { pollInterval, abortSignal }?: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.IAsyncSearchOptions", + "text": "IAsyncSearchOptions" + }, + ") => ", + "Observable", + "" + ], + "description": [], + "label": "pollSearch", + "source": { + "path": "src/plugins/data/common/search/poll_search.ts", + "lineNumber": 18 + }, + "tags": [], + "returnComment": [], + "initialIsOpen": false + }, { "id": "def-common.propFilter", "type": "Function", @@ -11403,123 +11537,32 @@ { "id": "def-common.splitStringInterval", "type": "Function", - "children": [ - { - "id": "def-common.splitStringInterval.$1", - "type": "string", - "label": "interval", - "isRequired": true, - "signature": [ - "string" - ], - "description": [], - "source": { - "path": "src/plugins/data/common/search/aggs/utils/date_interval_utils/parse_interval.ts", - "lineNumber": 16 - } - } - ], - "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", - "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", - "" - ], - "description": [], - "source": { - "path": "src/plugins/data/common/search/tabify/index.ts", - "lineNumber": 17 - } - }, + "children": [ { - "id": "def-common.tabify.$3", - "type": "CompoundType", - "label": "opts", + "id": "def-common.splitStringInterval.$1", + "type": "string", + "label": "interval", "isRequired": true, "signature": [ - "Partial<", - "TabbedResponseWriterOptions", - "> | ", - "TabifyDocsOptions" + "string" ], "description": [], "source": { - "path": "src/plugins/data/common/search/tabify/index.ts", - "lineNumber": 18 + "path": "src/plugins/data/common/search/aggs/utils/date_interval_utils/parse_interval.ts", + "lineNumber": 16 } } ], "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" - } + "(interval: string) => { value: number; unit: ", + "Unit", + "; } | null" ], "description": [], - "label": "tabify", + "label": "splitStringInterval", "source": { - "path": "src/plugins/data/common/search/tabify/index.ts", - "lineNumber": 15 + "path": "src/plugins/data/common/search/aggs/utils/date_interval_utils/parse_interval.ts", + "lineNumber": 16 }, "tags": [], "returnComment": [], @@ -11898,6 +11941,20 @@ "signature": [ "AggTypesRegistryStart" ] + }, + { + "tags": [], + "id": "def-common.AggConfigsOptions.hierarchical", + "type": "CompoundType", + "label": "hierarchical", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_configs.ts", + "lineNumber": 46 + }, + "signature": [ + "boolean | undefined" + ] } ], "source": { @@ -14455,7 +14512,7 @@ "description": [], "source": { "path": "src/plugins/data/common/search/aggs/buckets/terms.ts", - "lineNumber": 51 + "lineNumber": 49 } }, { @@ -14466,7 +14523,7 @@ "description": [], "source": { "path": "src/plugins/data/common/search/aggs/buckets/terms.ts", - "lineNumber": 52 + "lineNumber": 50 } }, { @@ -14477,7 +14534,7 @@ "description": [], "source": { "path": "src/plugins/data/common/search/aggs/buckets/terms.ts", - "lineNumber": 53 + "lineNumber": 51 }, "signature": [ "{ type: string; enabled?: boolean | undefined; id?: string | undefined; params?: {} | ", @@ -14493,7 +14550,7 @@ "description": [], "source": { "path": "src/plugins/data/common/search/aggs/buckets/terms.ts", - "lineNumber": 54 + "lineNumber": 52 }, "signature": [ "\"asc\" | \"desc\" | undefined" @@ -14507,7 +14564,7 @@ "description": [], "source": { "path": "src/plugins/data/common/search/aggs/buckets/terms.ts", - "lineNumber": 55 + "lineNumber": 53 }, "signature": [ "number | undefined" @@ -14521,7 +14578,7 @@ "description": [], "source": { "path": "src/plugins/data/common/search/aggs/buckets/terms.ts", - "lineNumber": 56 + "lineNumber": 54 }, "signature": [ "boolean | undefined" @@ -14535,7 +14592,7 @@ "description": [], "source": { "path": "src/plugins/data/common/search/aggs/buckets/terms.ts", - "lineNumber": 57 + "lineNumber": 55 }, "signature": [ "string | undefined" @@ -14549,7 +14606,7 @@ "description": [], "source": { "path": "src/plugins/data/common/search/aggs/buckets/terms.ts", - "lineNumber": 58 + "lineNumber": 56 }, "signature": [ "boolean | undefined" @@ -14563,7 +14620,7 @@ "description": [], "source": { "path": "src/plugins/data/common/search/aggs/buckets/terms.ts", - "lineNumber": 59 + "lineNumber": 57 }, "signature": [ "string | undefined" @@ -14577,7 +14634,7 @@ "description": [], "source": { "path": "src/plugins/data/common/search/aggs/buckets/terms.ts", - "lineNumber": 61 + "lineNumber": 59 }, "signature": [ "string | undefined" @@ -14591,7 +14648,7 @@ "description": [], "source": { "path": "src/plugins/data/common/search/aggs/buckets/terms.ts", - "lineNumber": 62 + "lineNumber": 60 }, "signature": [ "string | undefined" @@ -14600,7 +14657,7 @@ ], "source": { "path": "src/plugins/data/common/search/aggs/buckets/terms.ts", - "lineNumber": 50 + "lineNumber": 48 }, "initialIsOpen": false }, @@ -14721,7 +14778,7 @@ "description": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_type.ts", - "lineNumber": 26 + "lineNumber": 37 } }, { @@ -14732,7 +14789,7 @@ "description": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_type.ts", - "lineNumber": 27 + "lineNumber": 38 } }, { @@ -14743,7 +14800,7 @@ "description": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_type.ts", - "lineNumber": 28 + "lineNumber": 39 }, "signature": [ "((aggConfig: TAggConfig, key: any, params?: any) => any) | undefined" @@ -14757,7 +14814,7 @@ "description": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_type.ts", - "lineNumber": 29 + "lineNumber": 40 }, "signature": [ "string | undefined" @@ -14771,7 +14828,7 @@ "description": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_type.ts", - "lineNumber": 30 + "lineNumber": 41 }, "signature": [ "string | undefined" @@ -14785,7 +14842,7 @@ "description": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_type.ts", - "lineNumber": 31 + "lineNumber": 42 } }, { @@ -14796,7 +14853,7 @@ "description": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_type.ts", - "lineNumber": 32 + "lineNumber": 43 }, "signature": [ "((aggConfig: TAggConfig) => string) | (() => string) | undefined" @@ -14810,7 +14867,7 @@ "description": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_type.ts", - "lineNumber": 33 + "lineNumber": 44 }, "signature": [ "any" @@ -14824,7 +14881,7 @@ "description": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_type.ts", - "lineNumber": 34 + "lineNumber": 45 }, "signature": [ "boolean | undefined" @@ -14838,7 +14895,7 @@ "description": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_type.ts", - "lineNumber": 35 + "lineNumber": 46 }, "signature": [ "boolean | undefined" @@ -14852,7 +14909,7 @@ "description": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_type.ts", - "lineNumber": 36 + "lineNumber": 47 }, "signature": [ "Partial[] | undefined" @@ -14866,10 +14923,10 @@ "description": [], "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" + "\"string\" | \"number\" | \"boolean\" | \"object\" | \"date\" | \"ip\" | \"unknown\" | \"_source\" | \"attachment\" | \"geo_point\" | \"geo_shape\" | \"murmur3\" | \"conflict\" | \"nested\" | \"histogram\" | \"null\" | undefined" ] }, { @@ -14880,7 +14937,7 @@ "description": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_type.ts", - "lineNumber": 38 + "lineNumber": 49 }, "signature": [ "((aggConfig: TAggConfig) => TAggConfig[]) | (() => void | TAggConfig[]) | undefined" @@ -14894,7 +14951,7 @@ "description": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_type.ts", - "lineNumber": 39 + "lineNumber": 50 }, "signature": [ "((aggConfig: TAggConfig) => TAggConfig[]) | (() => void | TAggConfig[]) | undefined" @@ -14908,7 +14965,7 @@ "description": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_type.ts", - "lineNumber": 40 + "lineNumber": 51 }, "signature": [ "boolean | undefined" @@ -14922,7 +14979,7 @@ "description": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_type.ts", - "lineNumber": 41 + "lineNumber": 52 }, "signature": [ "boolean | undefined" @@ -14936,7 +14993,7 @@ "description": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_type.ts", - "lineNumber": 42 + "lineNumber": 53 }, "signature": [ "(() => any) | undefined" @@ -14950,34 +15007,10 @@ "description": [], "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" + "PostFlightRequestFn | undefined" ] }, { @@ -14988,7 +15021,7 @@ "description": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_type.ts", - "lineNumber": 52 + "lineNumber": 55 }, "signature": [ "((agg: TAggConfig) => ", @@ -15010,7 +15043,7 @@ "description": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_type.ts", - "lineNumber": 53 + "lineNumber": 56 }, "signature": [ "((agg: TAggConfig, bucket: any) => any) | undefined" @@ -15024,7 +15057,7 @@ "description": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_type.ts", - "lineNumber": 54 + "lineNumber": 57 }, "signature": [ "((bucket: any, key: any, agg: TAggConfig) => any) | undefined" @@ -15038,7 +15071,7 @@ "description": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_type.ts", - "lineNumber": 55 + "lineNumber": 58 }, "signature": [ "((agg: TAggConfig) => string) | undefined" @@ -15047,7 +15080,7 @@ ], "source": { "path": "src/plugins/data/common/search/aggs/agg_type.ts", - "lineNumber": 22 + "lineNumber": 33 }, "initialIsOpen": false }, @@ -15341,6 +15374,61 @@ }, "initialIsOpen": false }, + { + "id": "def-common.EqlSearchStrategyRequest", + "type": "Interface", + "label": "EqlSearchStrategyRequest", + "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" + }, + ">" + ], + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.EqlSearchStrategyRequest.options", + "type": "Object", + "label": "options", + "description": [], + "source": { + "path": "src/plugins/data/common/search/strategies/eql_search/types.ts", + "lineNumber": 19 + }, + "signature": [ + "TransportRequestOptions", + " | undefined" + ] + } + ], + "source": { + "path": "src/plugins/data/common/search/strategies/eql_search/types.ts", + "lineNumber": 18 + }, + "initialIsOpen": false + }, { "id": "def-common.EsRawResponse", "type": "Interface", @@ -15409,7 +15497,7 @@ "description": [], "source": { "path": "src/plugins/data/common/search/search_source/fetch/types.ts", - "lineNumber": 23 + "lineNumber": 22 }, "signature": [ { @@ -15431,42 +15519,32 @@ ], "source": { "path": "src/plugins/data/common/search/search_source/fetch/types.ts", - "lineNumber": 28 + "lineNumber": 27 }, "signature": [ "(request: Record, response: ", - "SearchResponse", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.IKibanaSearchResponse", + "text": "IKibanaSearchResponse" + }, ") => ", - "SearchResponse", - "" - ] - }, - { - "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 - }, - "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", - "section": "def-common.LegacyFetchHandlers", - "text": "LegacyFetchHandlers" - } + "section": "def-common.IKibanaSearchResponse", + "text": "IKibanaSearchResponse" + }, + "" ] } ], "source": { "path": "src/plugins/data/common/search/search_source/fetch/types.ts", - "lineNumber": 22 + "lineNumber": 21 }, "initialIsOpen": false }, @@ -15521,30 +15599,77 @@ }, { "tags": [], - "id": "def-common.HistogramBucketAggDependencies.getFieldFormatsStart", - "type": "Function", - "label": "getFieldFormatsStart", - "description": [], + "id": "def-common.HistogramBucketAggDependencies.getFieldFormatsStart", + "type": "Function", + "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": 30 + }, + "initialIsOpen": false + }, + { + "id": "def-common.IAsyncSearchOptions", + "type": "Interface", + "label": "IAsyncSearchOptions", + "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" + } + ], + "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": "src/plugins/data/common/search/aggs/buckets/histogram.ts", - "lineNumber": 32 + "path": "src/plugins/data/common/search/strategies/ese_search/types.ts", + "lineNumber": 17 }, "signature": [ - "() => Pick, \"deserialize\" | \"getDefaultInstance\">" + "number | undefined" ] } ], "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 }, "initialIsOpen": false }, @@ -15767,7 +15892,7 @@ "label": "indexType", "description": [], "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": [ @@ -15776,11 +15901,85 @@ } ], "source": { - "path": "src/plugins/data/common/search/es_search/types.ts", + "path": "src/plugins/data/common/search/strategies/es_search/types.ts", "lineNumber": 18 }, "initialIsOpen": false }, + { + "id": "def-common.IInspectorInfo", + "type": "Interface", + "label": "IInspectorInfo", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.IInspectorInfo.adapter", + "type": "Object", + "label": "adapter", + "description": [], + "source": { + "path": "src/plugins/data/common/search/types.ts", + "lineNumber": 84 + }, + "signature": [ + { + "pluginId": "inspector", + "scope": "common", + "docId": "kibInspectorPluginApi", + "section": "def-common.RequestAdapter", + "text": "RequestAdapter" + }, + " | undefined" + ] + }, + { + "tags": [], + "id": "def-common.IInspectorInfo.title", + "type": "string", + "label": "title", + "description": [], + "source": { + "path": "src/plugins/data/common/search/types.ts", + "lineNumber": 85 + } + }, + { + "tags": [], + "id": "def-common.IInspectorInfo.id", + "type": "string", + "label": "id", + "description": [], + "source": { + "path": "src/plugins/data/common/search/types.ts", + "lineNumber": 86 + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [], + "id": "def-common.IInspectorInfo.description", + "type": "string", + "label": "description", + "description": [], + "source": { + "path": "src/plugins/data/common/search/types.ts", + "lineNumber": 87 + }, + "signature": [ + "string | undefined" + ] + } + ], + "source": { + "path": "src/plugins/data/common/search/types.ts", + "lineNumber": 83 + }, + "initialIsOpen": false + }, { "id": "def-common.IKibanaSearchRequest", "type": "Interface", @@ -16110,7 +16309,7 @@ ], "source": { "path": "src/plugins/data/common/search/types.ts", - "lineNumber": 87 + "lineNumber": 94 }, "signature": [ "AbortSignal | undefined" @@ -16126,7 +16325,7 @@ ], "source": { "path": "src/plugins/data/common/search/types.ts", - "lineNumber": 92 + "lineNumber": 99 }, "signature": [ "string | undefined" @@ -16142,7 +16341,7 @@ ], "source": { "path": "src/plugins/data/common/search/types.ts", - "lineNumber": 98 + "lineNumber": 105 }, "signature": [ "boolean | undefined" @@ -16158,7 +16357,7 @@ ], "source": { "path": "src/plugins/data/common/search/types.ts", - "lineNumber": 103 + "lineNumber": 110 }, "signature": [ "string | undefined" @@ -16174,7 +16373,7 @@ ], "source": { "path": "src/plugins/data/common/search/types.ts", - "lineNumber": 108 + "lineNumber": 115 }, "signature": [ "boolean | undefined" @@ -16190,7 +16389,7 @@ ], "source": { "path": "src/plugins/data/common/search/types.ts", - "lineNumber": 114 + "lineNumber": 121 }, "signature": [ "boolean | undefined" @@ -16206,7 +16405,7 @@ ], "source": { "path": "src/plugins/data/common/search/types.ts", - "lineNumber": 120 + "lineNumber": 126 }, "signature": [ { @@ -16218,11 +16417,34 @@ }, " | undefined" ] + }, + { + "tags": [], + "id": "def-common.ISearchOptions.inspector", + "type": "Object", + "label": "inspector", + "description": [ + "\nInspector integration options" + ], + "source": { + "path": "src/plugins/data/common/search/types.ts", + "lineNumber": 131 + }, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.IInspectorInfo", + "text": "IInspectorInfo" + }, + " | undefined" + ] } ], "source": { "path": "src/plugins/data/common/search/types.ts", - "lineNumber": 83 + "lineNumber": 90 }, "initialIsOpen": false }, @@ -16247,7 +16469,7 @@ ], "source": { "path": "src/plugins/data/common/search/search_source/types.ts", - "lineNumber": 30 + "lineNumber": 31 }, "signature": [ "(fields?: ", @@ -16279,7 +16501,7 @@ ], "source": { "path": "src/plugins/data/common/search/search_source/types.ts", - "lineNumber": 34 + "lineNumber": 35 }, "signature": [ "() => Pick<", @@ -16296,7 +16518,7 @@ ], "source": { "path": "src/plugins/data/common/search/search_source/types.ts", - "lineNumber": 25 + "lineNumber": 26 }, "initialIsOpen": false }, @@ -16353,65 +16575,6 @@ }, "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 - }, - "signature": [ - "BehaviorSubject", - "" - ] - } - ], - "source": { - "path": "src/plugins/data/common/search/search_source/legacy/types.ts", - "lineNumber": 34 - }, - "initialIsOpen": false - }, { "id": "def-common.MetricAggParam", "type": "Interface", @@ -16502,7 +16665,7 @@ "description": [], "source": { "path": "src/plugins/data/common/search/search_source/legacy/types.ts", - "lineNumber": 25 + "lineNumber": 23 }, "signature": [ "MsearchRequest[]" @@ -16511,7 +16674,7 @@ ], "source": { "path": "src/plugins/data/common/search/search_source/legacy/types.ts", - "lineNumber": 24 + "lineNumber": 22 }, "initialIsOpen": false }, @@ -16530,7 +16693,7 @@ "description": [], "source": { "path": "src/plugins/data/common/search/search_source/legacy/types.ts", - "lineNumber": 30 + "lineNumber": 28 }, "signature": [ "ApiResponse", @@ -16542,7 +16705,7 @@ ], "source": { "path": "src/plugins/data/common/search/search_source/legacy/types.ts", - "lineNumber": 29 + "lineNumber": 27 }, "initialIsOpen": false }, @@ -16755,7 +16918,7 @@ "description": [], "source": { "path": "src/plugins/data/common/search/search_source/types.ts", - "lineNumber": 123 + "lineNumber": 132 }, "signature": [ "string[]" @@ -16769,7 +16932,7 @@ "description": [], "source": { "path": "src/plugins/data/common/search/search_source/types.ts", - "lineNumber": 124 + "lineNumber": 133 }, "signature": [ "unknown" @@ -16783,7 +16946,7 @@ "description": [], "source": { "path": "src/plugins/data/common/search/search_source/types.ts", - "lineNumber": 125 + "lineNumber": 134 }, "signature": [ "unknown" @@ -16797,7 +16960,7 @@ "description": [], "source": { "path": "src/plugins/data/common/search/search_source/types.ts", - "lineNumber": 126 + "lineNumber": 135 }, "signature": [ "unknown" @@ -16811,7 +16974,7 @@ "description": [], "source": { "path": "src/plugins/data/common/search/search_source/types.ts", - "lineNumber": 127 + "lineNumber": 136 }, "signature": [ "unknown" @@ -16825,7 +16988,7 @@ "description": [], "source": { "path": "src/plugins/data/common/search/search_source/types.ts", - "lineNumber": 128 + "lineNumber": 137 }, "signature": [ "string[]" @@ -16834,7 +16997,7 @@ ], "source": { "path": "src/plugins/data/common/search/search_source/types.ts", - "lineNumber": 122 + "lineNumber": 131 }, "initialIsOpen": false }, @@ -16853,7 +17016,7 @@ "description": [], "source": { "path": "src/plugins/data/common/search/search_source/types.ts", - "lineNumber": 132 + "lineNumber": 141 }, "signature": [ "{ failed: number; failures: ", @@ -16870,7 +17033,7 @@ ], "source": { "path": "src/plugins/data/common/search/search_source/types.ts", - "lineNumber": 131 + "lineNumber": 140 }, "initialIsOpen": false }, @@ -16889,7 +17052,7 @@ "description": [], "source": { "path": "src/plugins/data/common/search/search_source/fetch/types.ts", - "lineNumber": 40 + "lineNumber": 31 } }, { @@ -16900,7 +17063,7 @@ "description": [], "source": { "path": "src/plugins/data/common/search/search_source/fetch/types.ts", - "lineNumber": 41 + "lineNumber": 32 } }, { @@ -16911,7 +17074,7 @@ "description": [], "source": { "path": "src/plugins/data/common/search/search_source/fetch/types.ts", - "lineNumber": 42 + "lineNumber": 33 } }, { @@ -16922,7 +17085,7 @@ "description": [], "source": { "path": "src/plugins/data/common/search/search_source/fetch/types.ts", - "lineNumber": 43 + "lineNumber": 34 } }, { @@ -16933,7 +17096,7 @@ "description": [], "source": { "path": "src/plugins/data/common/search/search_source/fetch/types.ts", - "lineNumber": 44 + "lineNumber": 35 } }, { @@ -16944,13 +17107,13 @@ "description": [], "source": { "path": "src/plugins/data/common/search/search_source/fetch/types.ts", - "lineNumber": 45 + "lineNumber": 36 } } ], "source": { "path": "src/plugins/data/common/search/search_source/fetch/types.ts", - "lineNumber": 39 + "lineNumber": 30 }, "initialIsOpen": false }, @@ -17402,7 +17565,7 @@ "description": [], "source": { "path": "src/plugins/data/common/search/search_source/search_source.ts", - "lineNumber": 99 + "lineNumber": 117 }, "signature": [ { @@ -17417,7 +17580,7 @@ ], "source": { "path": "src/plugins/data/common/search/search_source/search_source.ts", - "lineNumber": 98 + "lineNumber": 116 }, "initialIsOpen": false }, @@ -17438,7 +17601,7 @@ "description": [], "source": { "path": "src/plugins/data/common/search/search_source/types.ts", - "lineNumber": 62 + "lineNumber": 71 }, "signature": [ "string | undefined" @@ -17454,7 +17617,7 @@ ], "source": { "path": "src/plugins/data/common/search/search_source/types.ts", - "lineNumber": 66 + "lineNumber": 75 }, "signature": [ { @@ -17477,7 +17640,7 @@ ], "source": { "path": "src/plugins/data/common/search/search_source/types.ts", - "lineNumber": 70 + "lineNumber": 79 }, "signature": [ { @@ -17524,7 +17687,7 @@ ], "source": { "path": "src/plugins/data/common/search/search_source/types.ts", - "lineNumber": 74 + "lineNumber": 83 }, "signature": [ "Record | Record[] | undefined" + } ] }, { @@ -17570,7 +17740,7 @@ "description": [], "source": { "path": "src/plugins/data/common/search/search_source/types.ts", - "lineNumber": 75 + "lineNumber": 84 }, "signature": [ "any" @@ -17584,7 +17754,7 @@ "description": [], "source": { "path": "src/plugins/data/common/search/search_source/types.ts", - "lineNumber": 76 + "lineNumber": 85 }, "signature": [ "boolean | undefined" @@ -17598,7 +17768,7 @@ "description": [], "source": { "path": "src/plugins/data/common/search/search_source/types.ts", - "lineNumber": 77 + "lineNumber": 86 }, "signature": [ "number | boolean | undefined" @@ -17607,17 +17777,25 @@ { "tags": [], "id": "def-common.SearchSourceFields.aggs", - "type": "Any", + "type": "CompoundType", "label": "aggs", "description": [ "\n{@link AggConfigs}" ], "source": { "path": "src/plugins/data/common/search/search_source/types.ts", - "lineNumber": 81 + "lineNumber": 90 }, "signature": [ - "any" + "object | ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.AggConfigs", + "text": "AggConfigs" + }, + " | (() => object) | undefined" ] }, { @@ -17628,7 +17806,7 @@ "description": [], "source": { "path": "src/plugins/data/common/search/search_source/types.ts", - "lineNumber": 82 + "lineNumber": 91 }, "signature": [ "number | undefined" @@ -17642,7 +17820,7 @@ "description": [], "source": { "path": "src/plugins/data/common/search/search_source/types.ts", - "lineNumber": 83 + "lineNumber": 92 }, "signature": [ "number | undefined" @@ -17656,7 +17834,7 @@ "description": [], "source": { "path": "src/plugins/data/common/search/search_source/types.ts", - "lineNumber": 84 + "lineNumber": 93 }, "signature": [ "string | boolean | string[] | undefined" @@ -17670,7 +17848,7 @@ "description": [], "source": { "path": "src/plugins/data/common/search/search_source/types.ts", - "lineNumber": 85 + "lineNumber": 94 }, "signature": [ "boolean | undefined" @@ -17686,7 +17864,7 @@ ], "source": { "path": "src/plugins/data/common/search/search_source/types.ts", - "lineNumber": 89 + "lineNumber": 98 }, "signature": [ { @@ -17711,7 +17889,7 @@ ], "source": { "path": "src/plugins/data/common/search/search_source/types.ts", - "lineNumber": 95 + "lineNumber": 104 }, "signature": [ "string | boolean | string[] | undefined" @@ -17727,7 +17905,7 @@ ], "source": { "path": "src/plugins/data/common/search/search_source/types.ts", - "lineNumber": 99 + "lineNumber": 108 }, "signature": [ { @@ -17748,7 +17926,7 @@ "description": [], "source": { "path": "src/plugins/data/common/search/search_source/types.ts", - "lineNumber": 100 + "lineNumber": 109 }, "signature": [ { @@ -17769,7 +17947,7 @@ "description": [], "source": { "path": "src/plugins/data/common/search/search_source/types.ts", - "lineNumber": 101 + "lineNumber": 110 }, "signature": [ "string | undefined" @@ -17783,7 +17961,7 @@ "description": [], "source": { "path": "src/plugins/data/common/search/search_source/types.ts", - "lineNumber": 102 + "lineNumber": 111 }, "signature": [ "number | undefined" @@ -17797,7 +17975,7 @@ "description": [], "source": { "path": "src/plugins/data/common/search/search_source/types.ts", - "lineNumber": 104 + "lineNumber": 113 }, "signature": [ { @@ -17813,7 +17991,7 @@ ], "source": { "path": "src/plugins/data/common/search/search_source/types.ts", - "lineNumber": 61 + "lineNumber": 70 }, "initialIsOpen": false }, @@ -17832,7 +18010,7 @@ "description": [], "source": { "path": "src/plugins/data/common/search/search_source/types.ts", - "lineNumber": 108 + "lineNumber": 117 }, "signature": [ "boolean | undefined" @@ -17841,222 +18019,116 @@ ], "source": { "path": "src/plugins/data/common/search/search_source/types.ts", - "lineNumber": 107 + "lineNumber": 116 }, "initialIsOpen": false }, { - "id": "def-common.SearchStrategyProvider", + "id": "def-common.ShardFailure", "type": "Interface", - "label": "SearchStrategyProvider", + "label": "ShardFailure", "description": [], "tags": [], "children": [ { "tags": [], - "id": "def-common.SearchStrategyProvider.id", + "id": "def-common.ShardFailure.index", "type": "string", - "label": "id", + "label": "index", "description": [], "source": { - "path": "src/plugins/data/common/search/search_source/legacy/types.ts", - "lineNumber": 48 + "path": "src/plugins/data/common/search/search_source/types.ts", + "lineNumber": 151 } }, { "tags": [], - "id": "def-common.SearchStrategyProvider.search", - "type": "Function", - "label": "search", + "id": "def-common.ShardFailure.node", + "type": "string", + "label": "node", "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" - }, - ") => ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.SearchStrategyResponse", - "text": "SearchStrategyResponse" - }, - "" - ] - } - ], - "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" + "path": "src/plugins/data/common/search/search_source/types.ts", + "lineNumber": 152 + } }, - "" - ], - "description": [], - "tags": [], - "children": [ { "tags": [], - "id": "def-common.SearchStrategyResponse.searching", + "id": "def-common.ShardFailure.reason", "type": "Object", - "label": "searching", + "label": "reason", "description": [], "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": 153 }, "signature": [ - "Promise<", - "SearchResponse", - "[]>" + "{ caused_by: { reason: string; type: string; }; reason: string; lang?: string | undefined; script?: string | undefined; script_stack?: string[] | undefined; type: string; }" ] }, { "tags": [], - "id": "def-common.SearchStrategyResponse.abort", - "type": "Function", - "label": "abort", + "id": "def-common.ShardFailure.shard", + "type": "number", + "label": "shard", "description": [], "source": { - "path": "src/plugins/data/common/search/search_source/legacy/types.ts", - "lineNumber": 54 - }, - "signature": [ - "() => void" - ] + "path": "src/plugins/data/common/search/search_source/types.ts", + "lineNumber": 164 + } } ], "source": { - "path": "src/plugins/data/common/search/search_source/legacy/types.ts", - "lineNumber": 52 + "path": "src/plugins/data/common/search/search_source/types.ts", + "lineNumber": 150 }, "initialIsOpen": false }, { - "id": "def-common.SearchStrategySearchParams", + "id": "def-common.SortDirectionFormat", "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" - } - ], + "label": "SortDirectionFormat", "description": [], "tags": [], "children": [ { "tags": [], - "id": "def-common.SearchStrategySearchParams.searchRequests", - "type": "Array", - "label": "searchRequests", + "id": "def-common.SortDirectionFormat.order", + "type": "Enum", + "label": "order", "description": [], "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": 46 }, "signature": [ - "Record[]" + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.SortDirection", + "text": "SortDirection" + } ] - } - ], - "source": { - "path": "src/plugins/data/common/search/search_source/legacy/types.ts", - "lineNumber": 42 - }, - "initialIsOpen": false - }, - { - "id": "def-common.ShardFailure", - "type": "Interface", - "label": "ShardFailure", - "description": [], - "tags": [], - "children": [ - { - "tags": [], - "id": "def-common.ShardFailure.index", - "type": "string", - "label": "index", - "description": [], - "source": { - "path": "src/plugins/data/common/search/search_source/types.ts", - "lineNumber": 142 - } }, { "tags": [], - "id": "def-common.ShardFailure.node", + "id": "def-common.SortDirectionFormat.format", "type": "string", - "label": "node", - "description": [], - "source": { - "path": "src/plugins/data/common/search/search_source/types.ts", - "lineNumber": 143 - } - }, - { - "tags": [], - "id": "def-common.ShardFailure.reason", - "type": "Object", - "label": "reason", + "label": "format", "description": [], "source": { "path": "src/plugins/data/common/search/search_source/types.ts", - "lineNumber": 144 + "lineNumber": 47 }, "signature": [ - "{ caused_by: { reason: string; type: string; }; reason: string; lang?: string | undefined; script?: string | undefined; script_stack?: string[] | undefined; type: string; }" + "string | undefined" ] - }, - { - "tags": [], - "id": "def-common.ShardFailure.shard", - "type": "number", - "label": "shard", - "description": [], - "source": { - "path": "src/plugins/data/common/search/search_source/types.ts", - "lineNumber": 155 - } } ], "source": { "path": "src/plugins/data/common/search/search_source/types.ts", - "lineNumber": 141 + "lineNumber": 45 }, "initialIsOpen": false }, @@ -18075,7 +18147,7 @@ "description": [], "source": { "path": "src/plugins/data/common/search/search_source/types.ts", - "lineNumber": 45 + "lineNumber": 51 }, "signature": [ { @@ -18095,7 +18167,7 @@ "description": [], "source": { "path": "src/plugins/data/common/search/search_source/types.ts", - "lineNumber": 46 + "lineNumber": 52 }, "signature": [ "\"date\" | \"long\" | \"double\" | \"date_nanos\" | undefined" @@ -18104,7 +18176,7 @@ ], "source": { "path": "src/plugins/data/common/search/search_source/types.ts", - "lineNumber": 44 + "lineNumber": 50 }, "initialIsOpen": false }, @@ -18123,7 +18195,7 @@ "description": [], "source": { "path": "src/plugins/data/common/search/search_source/types.ts", - "lineNumber": 112 + "lineNumber": 121 }, "signature": [ "\"max\" | \"min\" | \"sum\" | \"avg\" | \"median\" | undefined" @@ -18137,7 +18209,7 @@ "description": [], "source": { "path": "src/plugins/data/common/search/search_source/types.ts", - "lineNumber": 113 + "lineNumber": 122 }, "signature": [ "\"date\" | \"long\" | \"double\" | \"date_nanos\" | undefined" @@ -18151,7 +18223,7 @@ "description": [], "source": { "path": "src/plugins/data/common/search/search_source/types.ts", - "lineNumber": 114 + "lineNumber": 123 }, "signature": [ "object | undefined" @@ -18165,7 +18237,7 @@ "description": [], "source": { "path": "src/plugins/data/common/search/search_source/types.ts", - "lineNumber": 115 + "lineNumber": 124 }, "signature": [ "string | undefined" @@ -18179,7 +18251,7 @@ "description": [], "source": { "path": "src/plugins/data/common/search/search_source/types.ts", - "lineNumber": 116 + "lineNumber": 125 }, "signature": [ "\"arc\" | \"plane\" | undefined" @@ -18193,7 +18265,7 @@ "description": [], "source": { "path": "src/plugins/data/common/search/search_source/types.ts", - "lineNumber": 117 + "lineNumber": 126 }, "signature": [ "string | undefined" @@ -18207,7 +18279,7 @@ "description": [], "source": { "path": "src/plugins/data/common/search/search_source/types.ts", - "lineNumber": 118 + "lineNumber": 127 }, "signature": [ "boolean | undefined" @@ -18221,7 +18293,7 @@ "description": [], "source": { "path": "src/plugins/data/common/search/search_source/types.ts", - "lineNumber": 119 + "lineNumber": 128 }, "signature": [ "object | undefined" @@ -18230,7 +18302,7 @@ ], "source": { "path": "src/plugins/data/common/search/search_source/types.ts", - "lineNumber": 111 + "lineNumber": 120 }, "initialIsOpen": false } @@ -18292,7 +18364,7 @@ "description": [], "source": { "path": "src/plugins/data/common/search/search_source/types.ts", - "lineNumber": 39 + "lineNumber": 40 }, "initialIsOpen": false } @@ -18951,7 +19023,7 @@ "description": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_configs.ts", - "lineNumber": 48 + "lineNumber": 49 }, "signature": [ "{ type: string | IAggType; enabled?: boolean | undefined; id?: string | undefined; schema?: string | undefined; params?: {} | ", @@ -18960,6 +19032,66 @@ ], "initialIsOpen": false }, + { + "tags": [], + "id": "def-common.ENHANCED_ES_SEARCH_STRATEGY", + "type": "string", + "label": "ENHANCED_ES_SEARCH_STRATEGY", + "description": [], + "source": { + "path": "src/plugins/data/common/search/strategies/ese_search/types.ts", + "lineNumber": 11 + }, + "signature": [ + "\"ese\"" + ], + "initialIsOpen": false + }, + { + "tags": [], + "id": "def-common.EQL_SEARCH_STRATEGY", + "type": "string", + "label": "EQL_SEARCH_STRATEGY", + "description": [], + "source": { + "path": "src/plugins/data/common/search/strategies/eql_search/types.ts", + "lineNumber": 14 + }, + "signature": [ + "\"eql\"" + ], + "initialIsOpen": false + }, + { + "id": "def-common.EqlRequestParams", + "type": "Type", + "label": "EqlRequestParams", + "tags": [], + "description": [], + "source": { + "path": "src/plugins/data/common/search/strategies/eql_search/types.ts", + "lineNumber": 16 + }, + "signature": [ + "EqlSearch>" + ], + "initialIsOpen": false + }, + { + "id": "def-common.EqlSearchStrategyResponse", + "type": "Type", + "label": "EqlSearchStrategyResponse", + "tags": [], + "description": [], + "source": { + "path": "src/plugins/data/common/search/strategies/eql_search/types.ts", + "lineNumber": 22 + }, + "signature": [ + "IKibanaSearchResponse>" + ], + "initialIsOpen": false + }, { "tags": [], "id": "def-common.ES_SEARCH_STRATEGY", @@ -18967,7 +19099,7 @@ "label": "ES_SEARCH_STRATEGY", "description": [], "source": { - "path": "src/plugins/data/common/search/es_search/types.ts", + "path": "src/plugins/data/common/search/strategies/es_search/types.ts", "lineNumber": 12 }, "signature": [ @@ -19064,7 +19196,7 @@ "description": [], "source": { "path": "src/plugins/data/common/search/search_source/types.ts", - "lineNumber": 37 + "lineNumber": 38 }, "signature": [ "[", @@ -19083,10 +19215,10 @@ "description": [], "source": { "path": "src/plugins/data/common/search/search_source/types.ts", - "lineNumber": 49 + "lineNumber": 55 }, "signature": [ - "{ [x: string]: SortDirection | SortDirectionNumeric; }" + "{ [x: string]: SortDirection | SortDirectionNumeric | SortDirectionFormat; }" ], "initialIsOpen": false }, @@ -19678,7 +19810,7 @@ "description": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_type.ts", - "lineNumber": 59 + "lineNumber": 62 }, "signature": [ "AggType>" @@ -19692,7 +19824,7 @@ "tags": [], "description": [], "source": { - "path": "src/plugins/data/common/search/es_search/types.ts", + "path": "src/plugins/data/common/search/strategies/es_search/types.ts", "lineNumber": 22 }, "signature": [ @@ -19893,7 +20025,7 @@ ], "source": { "path": "src/plugins/data/common/search/types.ts", - "lineNumber": 127 + "lineNumber": 138 }, "signature": [ "{ isStored?: boolean | undefined; isRestore?: boolean | undefined; sessionId?: string | undefined; strategy?: string | undefined; legacyHitsTotal?: boolean | undefined; }" @@ -19907,7 +20039,7 @@ "tags": [], "description": [], "source": { - "path": "src/plugins/data/common/search/es_search/types.ts", + "path": "src/plugins/data/common/search/strategies/es_search/types.ts", "lineNumber": 14 }, "signature": [ @@ -19927,31 +20059,37 @@ ], "source": { "path": "src/plugins/data/common/search/search_source/types.ts", - "lineNumber": 19 + "lineNumber": 20 }, "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" + } ], "initialIsOpen": false }, @@ -20125,7 +20263,7 @@ "description": [], "source": { "path": "src/plugins/data/common/search/search_source/types.ts", - "lineNumber": 56 + "lineNumber": 65 }, "signature": [ "string | SearchField" @@ -20152,7 +20290,7 @@ "description": [], "source": { "path": "src/plugins/data/common/search/aggs/buckets/terms.ts", - "lineNumber": 32 + "lineNumber": 30 }, "signature": [ "string[]" diff --git a/api_docs/data_ui.json b/api_docs/data_ui.json index e121f55bd6bbf..3175263de68db 100644 --- a/api_docs/data_ui.json +++ b/api_docs/data_ui.json @@ -460,7 +460,7 @@ "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; }" + "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; }" ], "initialIsOpen": false }, diff --git a/api_docs/dev_tools.json b/api_docs/dev_tools.json index a2215041f27cd..24403028ce405 100644 --- a/api_docs/dev_tools.json +++ b/api_docs/dev_tools.json @@ -141,7 +141,7 @@ "returnComment": [], "source": { "path": "src/plugins/dev_tools/public/plugin.ts", - "lineNumber": 90 + "lineNumber": 104 } } ], diff --git a/api_docs/discover.json b/api_docs/discover.json index 246382a449fc3..b5d33291ab4f2 100644 --- a/api_docs/discover.json +++ b/api_docs/discover.json @@ -791,12 +791,12 @@ "description": [], "source": { "path": "src/plugins/discover/public/plugin.tsx", - "lineNumber": 76 + "lineNumber": 77 }, "signature": [ - "{ addDocView(docViewRaw: ", - "DocViewInput", - " | ", + "{ addDocView(docViewRaw: ComponentDocViewInput | ", + "RenderDocViewInput", + " | DirectiveDocViewInput | ", "DocViewInputFn", "): void; }" ] @@ -804,7 +804,7 @@ ], "source": { "path": "src/plugins/discover/public/plugin.tsx", - "lineNumber": 75 + "lineNumber": 76 }, "lifecycle": "setup", "initialIsOpen": true @@ -824,7 +824,7 @@ "description": [], "source": { "path": "src/plugins/discover/public/plugin.tsx", - "lineNumber": 87 + "lineNumber": 88 }, "signature": [ { @@ -846,7 +846,7 @@ ], "source": { "path": "src/plugins/discover/public/plugin.tsx", - "lineNumber": 105 + "lineNumber": 106 }, "signature": [ { @@ -862,7 +862,7 @@ ], "source": { "path": "src/plugins/discover/public/plugin.tsx", - "lineNumber": 86 + "lineNumber": 87 }, "lifecycle": "start", "initialIsOpen": true @@ -987,6 +987,21 @@ ], "initialIsOpen": false }, + { + "tags": [], + "id": "def-common.MAX_DOC_FIELDS_DISPLAYED", + "type": "string", + "label": "MAX_DOC_FIELDS_DISPLAYED", + "description": [], + "source": { + "path": "src/plugins/discover/common/index.ts", + "lineNumber": 21 + }, + "signature": [ + "\"discover:maxDocFieldsDisplayed\"" + ], + "initialIsOpen": false + }, { "tags": [], "id": "def-common.MODIFY_COLUMNS_ON_SWITCH", diff --git a/api_docs/discover_enhanced.json b/api_docs/discover_enhanced.json index 6ff98fb2b2efa..bf9c79b5b0694 100644 --- a/api_docs/discover_enhanced.json +++ b/api_docs/discover_enhanced.json @@ -233,7 +233,7 @@ "description": [], "source": { "path": "x-pack/plugins/discover_enhanced/public/plugin.ts", - "lineNumber": 69 + "lineNumber": 71 } }, { @@ -253,7 +253,7 @@ "description": [], "source": { "path": "x-pack/plugins/discover_enhanced/public/plugin.ts", - "lineNumber": 69 + "lineNumber": 71 } } ], @@ -261,7 +261,7 @@ "returnComment": [], "source": { "path": "x-pack/plugins/discover_enhanced/public/plugin.ts", - "lineNumber": 69 + "lineNumber": 71 } }, { @@ -277,7 +277,7 @@ "returnComment": [], "source": { "path": "x-pack/plugins/discover_enhanced/public/plugin.ts", - "lineNumber": 71 + "lineNumber": 73 } } ], @@ -831,7 +831,7 @@ "lineNumber": 9 }, "signature": [ - "{ exploreDataInChart: { enabled: boolean; }; }" + "{ exploreDataInChart: { enabled: boolean; }; exploreDataInContextMenu: { enabled: boolean; }; }" ] } ], diff --git a/api_docs/embeddable.json b/api_docs/embeddable.json index c1b8313259aee..03d3f42cccbc9 100644 --- a/api_docs/embeddable.json +++ b/api_docs/embeddable.json @@ -3511,7 +3511,7 @@ "type": "Function", "label": "navigateToEditor", "signature": [ - "(appId: string, options?: { path?: string | undefined; state: ", + "(appId: string, options?: { path?: string | undefined; openInNewTab?: boolean | undefined; state: ", { "pluginId": "embeddable", "scope": "public", @@ -3560,6 +3560,20 @@ "string | undefined" ] }, + { + "tags": [], + "id": "def-public.EmbeddableStateTransfer.navigateToEditor.$2.options.openInNewTab", + "type": "CompoundType", + "label": "openInNewTab", + "description": [], + "source": { + "path": "src/plugins/embeddable/public/lib/state_transfer/embeddable_state_transfer.ts", + "lineNumber": 118 + }, + "signature": [ + "boolean | undefined" + ] + }, { "tags": [], "id": "def-public.EmbeddableStateTransfer.navigateToEditor.$2.options.state", @@ -3568,7 +3582,7 @@ "description": [], "source": { "path": "src/plugins/embeddable/public/lib/state_transfer/embeddable_state_transfer.ts", - "lineNumber": 118 + "lineNumber": 119 }, "signature": [ { @@ -3624,7 +3638,7 @@ "description": [], "source": { "path": "src/plugins/embeddable/public/lib/state_transfer/embeddable_state_transfer.ts", - "lineNumber": 132 + "lineNumber": 133 } }, { @@ -3642,7 +3656,7 @@ "description": [], "source": { "path": "src/plugins/embeddable/public/lib/state_transfer/embeddable_state_transfer.ts", - "lineNumber": 133 + "lineNumber": 134 }, "signature": [ "string | undefined" @@ -3656,7 +3670,7 @@ "description": [], "source": { "path": "src/plugins/embeddable/public/lib/state_transfer/embeddable_state_transfer.ts", - "lineNumber": 133 + "lineNumber": 134 }, "signature": [ { @@ -3671,7 +3685,7 @@ ], "source": { "path": "src/plugins/embeddable/public/lib/state_transfer/embeddable_state_transfer.ts", - "lineNumber": 133 + "lineNumber": 134 } } ], @@ -3679,7 +3693,7 @@ "returnComment": [], "source": { "path": "src/plugins/embeddable/public/lib/state_transfer/embeddable_state_transfer.ts", - "lineNumber": 131 + "lineNumber": 132 } } ], @@ -4924,6 +4938,20 @@ "signature": [ "React.ComponentType" ] + }, + { + "tags": [], + "id": "def-public.openAddPanelFlyout.$1.options.showCreateNewMenu", + "type": "CompoundType", + "label": "showCreateNewMenu", + "description": [], + "source": { + "path": "src/plugins/embeddable/public/lib/panel/panel_header/panel_actions/add_panel/open_add_panel_flyout.tsx", + "lineNumber": 23 + }, + "signature": [ + "boolean | undefined" + ] } ], "source": { @@ -5436,7 +5464,7 @@ "description": [], "source": { "path": "src/plugins/embeddable/public/lib/embeddables/embeddable_factory.ts", - "lineNumber": 41 + "lineNumber": 42 } }, { @@ -5449,7 +5477,7 @@ ], "source": { "path": "src/plugins/embeddable/public/lib/embeddables/embeddable_factory.ts", - "lineNumber": 47 + "lineNumber": 48 }, "signature": [ "() => Promise" @@ -5463,7 +5491,7 @@ "description": [], "source": { "path": "src/plugins/embeddable/public/lib/embeddables/embeddable_factory.ts", - "lineNumber": 49 + "lineNumber": 50 }, "signature": [ { @@ -5476,6 +5504,29 @@ " | undefined" ] }, + { + "tags": [], + "id": "def-public.EmbeddableFactory.grouping", + "type": "Array", + "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" + ], + "source": { + "path": "src/plugins/embeddable/public/lib/embeddables/embeddable_factory.ts", + "lineNumber": 56 + }, + "signature": [ + { + "pluginId": "uiActions", + "scope": "public", + "docId": "kibUiActionsPluginApi", + "section": "def-public.PresentableGrouping", + "text": "PresentableGrouping" + }, + " | undefined" + ] + }, { "tags": [], "id": "def-public.EmbeddableFactory.isContainerType", @@ -5486,7 +5537,7 @@ ], "source": { "path": "src/plugins/embeddable/public/lib/embeddables/embeddable_factory.ts", - "lineNumber": 57 + "lineNumber": 64 } }, { @@ -5504,7 +5555,43 @@ "returnComment": [], "source": { "path": "src/plugins/embeddable/public/lib/embeddables/embeddable_factory.ts", - "lineNumber": 63 + "lineNumber": 70 + } + }, + { + "id": "def-public.EmbeddableFactory.getIconType", + "type": "Function", + "label": "getIconType", + "signature": [ + "() => string" + ], + "description": [ + "\nReturns an EUI Icon type to be displayed in a menu." + ], + "children": [], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/embeddable/public/lib/embeddables/embeddable_factory.ts", + "lineNumber": 75 + } + }, + { + "id": "def-public.EmbeddableFactory.getDescription", + "type": "Function", + "label": "getDescription", + "signature": [ + "() => string" + ], + "description": [ + "\nReturns a description about the embeddable." + ], + "children": [], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/embeddable/public/lib/embeddables/embeddable_factory.ts", + "lineNumber": 80 } }, { @@ -5522,7 +5609,7 @@ "returnComment": [], "source": { "path": "src/plugins/embeddable/public/lib/embeddables/embeddable_factory.ts", - "lineNumber": 69 + "lineNumber": 86 } }, { @@ -5547,7 +5634,7 @@ "description": [], "source": { "path": "src/plugins/embeddable/public/lib/embeddables/embeddable_factory.ts", - "lineNumber": 77 + "lineNumber": 94 } } ], @@ -5555,7 +5642,7 @@ "returnComment": [], "source": { "path": "src/plugins/embeddable/public/lib/embeddables/embeddable_factory.ts", - "lineNumber": 77 + "lineNumber": 94 } }, { @@ -5573,7 +5660,7 @@ "returnComment": [], "source": { "path": "src/plugins/embeddable/public/lib/embeddables/embeddable_factory.ts", - "lineNumber": 84 + "lineNumber": 101 } }, { @@ -5630,7 +5717,7 @@ "description": [], "source": { "path": "src/plugins/embeddable/public/lib/embeddables/embeddable_factory.ts", - "lineNumber": 94 + "lineNumber": 111 } }, { @@ -5646,7 +5733,7 @@ ], "source": { "path": "src/plugins/embeddable/public/lib/embeddables/embeddable_factory.ts", - "lineNumber": 95 + "lineNumber": 112 } }, { @@ -5683,7 +5770,7 @@ "description": [], "source": { "path": "src/plugins/embeddable/public/lib/embeddables/embeddable_factory.ts", - "lineNumber": 96 + "lineNumber": 113 } } ], @@ -5691,7 +5778,7 @@ "returnComment": [], "source": { "path": "src/plugins/embeddable/public/lib/embeddables/embeddable_factory.ts", - "lineNumber": 93 + "lineNumber": 110 } }, { @@ -5748,7 +5835,7 @@ "description": [], "source": { "path": "src/plugins/embeddable/public/lib/embeddables/embeddable_factory.ts", - "lineNumber": 106 + "lineNumber": 123 } }, { @@ -5785,7 +5872,7 @@ "description": [], "source": { "path": "src/plugins/embeddable/public/lib/embeddables/embeddable_factory.ts", - "lineNumber": 107 + "lineNumber": 124 } } ], @@ -5793,13 +5880,13 @@ "returnComment": [], "source": { "path": "src/plugins/embeddable/public/lib/embeddables/embeddable_factory.ts", - "lineNumber": 105 + "lineNumber": 122 } } ], "source": { "path": "src/plugins/embeddable/public/lib/embeddables/embeddable_factory.ts", - "lineNumber": 30 + "lineNumber": 31 }, "initialIsOpen": false }, @@ -5818,7 +5905,7 @@ "description": [], "source": { "path": "src/plugins/embeddable/public/lib/embeddables/embeddable_factory.ts", - "lineNumber": 19 + "lineNumber": 20 } }, { @@ -5829,7 +5916,7 @@ "description": [], "source": { "path": "src/plugins/embeddable/public/lib/embeddables/embeddable_factory.ts", - "lineNumber": 20 + "lineNumber": 21 }, "signature": [ "string | undefined" @@ -5838,7 +5925,7 @@ ], "source": { "path": "src/plugins/embeddable/public/lib/embeddables/embeddable_factory.ts", - "lineNumber": 18 + "lineNumber": 19 }, "initialIsOpen": false }, @@ -7096,7 +7183,7 @@ "description": [], "source": { "path": "src/plugins/embeddable/public/lib/embeddables/embeddable_factory.ts", - "lineNumber": 24 + "lineNumber": 25 }, "signature": [ "any" @@ -7105,7 +7192,7 @@ ], "source": { "path": "src/plugins/embeddable/public/lib/embeddables/embeddable_factory.ts", - "lineNumber": 23 + "lineNumber": 24 }, "initialIsOpen": false }, @@ -7594,7 +7681,7 @@ "lineNumber": 14 }, "signature": [ - "Pick, \"type\" | \"create\" | \"isEditable\" | \"getDisplayName\"> & Partial, \"createFromSavedObject\" | \"isContainerType\" | \"getExplicitInput\" | \"savedObjectMetaData\" | \"canCreateNew\" | \"getDefaultInput\" | \"telemetry\" | \"extract\" | \"inject\" | \"migrations\">>" + "Pick, \"type\" | \"create\" | \"isEditable\" | \"getDisplayName\"> & Partial, \"createFromSavedObject\" | \"isContainerType\" | \"getExplicitInput\" | \"savedObjectMetaData\" | \"canCreateNew\" | \"getDefaultInput\" | \"telemetry\" | \"extract\" | \"inject\" | \"migrations\" | \"grouping\" | \"getIconType\" | \"getDescription\">>" ], "initialIsOpen": false }, @@ -8443,6 +8530,22 @@ }, "lifecycle": "setup", "initialIsOpen": true + }, + "start": { + "id": "def-server.EmbeddableStart", + "type": "Type", + "label": "EmbeddableStart", + "tags": [], + "description": [], + "source": { + "path": "src/plugins/embeddable/server/plugin.ts", + "lineNumber": 32 + }, + "signature": [ + "PersistableStateService" + ], + "lifecycle": "start", + "initialIsOpen": true } }, "common": { 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..42462bbec32a3 100644 --- a/api_docs/embeddable_enhanced.json +++ b/api_docs/embeddable_enhanced.json @@ -143,7 +143,7 @@ "description": [], "source": { "path": "x-pack/plugins/embeddable_enhanced/public/plugin.ts", - "lineNumber": 36 + "lineNumber": 35 }, "signature": [ { @@ -163,7 +163,7 @@ "description": [], "source": { "path": "x-pack/plugins/embeddable_enhanced/public/plugin.ts", - "lineNumber": 37 + "lineNumber": 36 }, "signature": [ { @@ -178,7 +178,7 @@ ], "source": { "path": "x-pack/plugins/embeddable_enhanced/public/plugin.ts", - "lineNumber": 35 + "lineNumber": 34 }, "initialIsOpen": false }, @@ -197,7 +197,7 @@ "description": [], "source": { "path": "x-pack/plugins/embeddable_enhanced/public/plugin.ts", - "lineNumber": 41 + "lineNumber": 40 }, "signature": [ { @@ -217,7 +217,7 @@ "description": [], "source": { "path": "x-pack/plugins/embeddable_enhanced/public/plugin.ts", - "lineNumber": 42 + "lineNumber": 41 }, "signature": [ { @@ -232,7 +232,7 @@ ], "source": { "path": "x-pack/plugins/embeddable_enhanced/public/plugin.ts", - "lineNumber": 40 + "lineNumber": 39 }, "initialIsOpen": false } @@ -311,7 +311,7 @@ "children": [], "source": { "path": "x-pack/plugins/embeddable_enhanced/public/plugin.ts", - "lineNumber": 46 + "lineNumber": 45 }, "lifecycle": "setup", "initialIsOpen": true @@ -325,7 +325,7 @@ "children": [], "source": { "path": "x-pack/plugins/embeddable_enhanced/public/plugin.ts", - "lineNumber": 49 + "lineNumber": 48 }, "lifecycle": "start", "initialIsOpen": true diff --git a/api_docs/es_ui_shared.json b/api_docs/es_ui_shared.json index ac32be544759c..cc3df6cbd9f8b 100644 --- a/api_docs/es_ui_shared.json +++ b/api_docs/es_ui_shared.json @@ -1282,7 +1282,7 @@ "description": [], "source": { "path": "src/plugins/es_ui_shared/__packages_do_not_import__/errors/handle_es_error.ts", - "lineNumber": 23 + "lineNumber": 25 } } ], @@ -1297,13 +1297,17 @@ }, "" ], - "description": [], + "description": [ + "\nFor errors returned by the new elasticsearch js client.\n" + ], "label": "handleEsError", "source": { "path": "src/plugins/es_ui_shared/__packages_do_not_import__/errors/handle_es_error.ts", - "lineNumber": 23 + "lineNumber": 25 }, - "tags": [], + "tags": [ + "throws" + ], "returnComment": [], "initialIsOpen": false }, diff --git a/api_docs/expressions.json b/api_docs/expressions.json index 7355d2904e63b..feb6d56c28439 100644 --- a/api_docs/expressions.json +++ b/api_docs/expressions.json @@ -29,7 +29,7 @@ ], "source": { "path": "src/plugins/expressions/common/execution/execution.ts", - "lineNumber": 80 + "lineNumber": 94 }, "signature": [ { @@ -76,7 +76,7 @@ ], "source": { "path": "src/plugins/expressions/common/execution/execution.ts", - "lineNumber": 88 + "lineNumber": 102 }, "signature": [ "Input" @@ -92,7 +92,7 @@ ], "source": { "path": "src/plugins/expressions/common/execution/execution.ts", - "lineNumber": 94 + "lineNumber": 113 }, "signature": [ { @@ -109,50 +109,19 @@ }, { "tags": [], - "id": "def-public.Execution.contract", + "id": "def-public.Execution.result", "type": "Object", - "label": "contract", + "label": "result", "description": [ - "\nContract is a public representation of `Execution` instances. Contract we\ncan return to other plugins for their consumption." + "\nFuture that tracks result or error of this execution." ], - "source": { - "path": "src/plugins/expressions/common/execution/execution.ts", - "lineNumber": 134 - }, - "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 - } - }, - { - "id": "def-public.Execution.result", - "type": "Object", - "label": "result", - "tags": [], - "description": [], - "source": { - "path": "src/plugins/expressions/common/execution/execution.ts", - "lineNumber": 142 }, "signature": [ - "Promise>" ] }, + { + "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": 153 + }, + "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": 159 + } + }, { "id": "def-public.Execution.inspectorAdapters", "type": "Uncategorized", @@ -187,7 +190,7 @@ "description": [], "source": { "path": "src/plugins/expressions/common/execution/execution.ts", - "lineNumber": 146 + "lineNumber": 161 }, "signature": [ "InspectorAdapters" @@ -219,7 +222,7 @@ "description": [], "source": { "path": "src/plugins/expressions/common/execution/execution.ts", - "lineNumber": 150 + "lineNumber": 165 } } ], @@ -227,7 +230,7 @@ "returnComment": [], "source": { "path": "src/plugins/expressions/common/execution/execution.ts", - "lineNumber": 150 + "lineNumber": 165 } }, { @@ -245,7 +248,7 @@ "returnComment": [], "source": { "path": "src/plugins/expressions/common/execution/execution.ts", - "lineNumber": 192 + "lineNumber": 229 } }, { @@ -253,7 +256,33 @@ "type": "Function", "label": "start", "signature": [ - "(input?: Input) => void" + "(input?: Input) => ", + "Observable", + ">" ], "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." @@ -270,7 +299,7 @@ "description": [], "source": { "path": "src/plugins/expressions/common/execution/execution.ts", - "lineNumber": 202 + "lineNumber": 239 } } ], @@ -278,7 +307,7 @@ "returnComment": [], "source": { "path": "src/plugins/expressions/common/execution/execution.ts", - "lineNumber": 202 + "lineNumber": 239 } }, { @@ -294,7 +323,9 @@ "section": "def-common.ExpressionAstFunction", "text": "ExpressionAstFunction" }, - "[], input: unknown) => Promise" + "[], input: unknown) => ", + "Observable", + "" ], "description": [], "children": [ @@ -316,7 +347,7 @@ "description": [], "source": { "path": "src/plugins/expressions/common/execution/execution.ts", - "lineNumber": 236 + "lineNumber": 263 } }, { @@ -330,7 +361,7 @@ "description": [], "source": { "path": "src/plugins/expressions/common/execution/execution.ts", - "lineNumber": 236 + "lineNumber": 263 } } ], @@ -338,7 +369,7 @@ "returnComment": [], "source": { "path": "src/plugins/expressions/common/execution/execution.ts", - "lineNumber": 236 + "lineNumber": 263 } }, { @@ -354,7 +385,9 @@ "section": "def-common.ExpressionFunction", "text": "ExpressionFunction" }, - ", input: unknown, args: Record) => Promise" + ", input: unknown, args: Record) => ", + "Observable", + "" ], "description": [], "children": [ @@ -375,7 +408,7 @@ "description": [], "source": { "path": "src/plugins/expressions/common/execution/execution.ts", - "lineNumber": 317 + "lineNumber": 337 } }, { @@ -389,7 +422,7 @@ "description": [], "source": { "path": "src/plugins/expressions/common/execution/execution.ts", - "lineNumber": 318 + "lineNumber": 338 } }, { @@ -403,7 +436,7 @@ "description": [], "source": { "path": "src/plugins/expressions/common/execution/execution.ts", - "lineNumber": 319 + "lineNumber": 339 } } ], @@ -411,7 +444,7 @@ "returnComment": [], "source": { "path": "src/plugins/expressions/common/execution/execution.ts", - "lineNumber": 316 + "lineNumber": 336 } }, { @@ -434,7 +467,7 @@ "description": [], "source": { "path": "src/plugins/expressions/common/execution/execution.ts", - "lineNumber": 348 + "lineNumber": 374 } }, { @@ -448,7 +481,7 @@ "description": [], "source": { "path": "src/plugins/expressions/common/execution/execution.ts", - "lineNumber": 348 + "lineNumber": 374 } } ], @@ -456,7 +489,7 @@ "returnComment": [], "source": { "path": "src/plugins/expressions/common/execution/execution.ts", - "lineNumber": 348 + "lineNumber": 374 } }, { @@ -472,7 +505,9 @@ "section": "def-common.ExpressionFunction", "text": "ExpressionFunction" }, - ", input: unknown, argAsts: any) => Promise" + ", input: unknown, argAsts: any) => ", + "Observable", + "" ], "description": [], "children": [ @@ -493,7 +528,7 @@ "description": [], "source": { "path": "src/plugins/expressions/common/execution/execution.ts", - "lineNumber": 374 + "lineNumber": 400 } }, { @@ -507,7 +542,7 @@ "description": [], "source": { "path": "src/plugins/expressions/common/execution/execution.ts", - "lineNumber": 374 + "lineNumber": 400 } }, { @@ -521,7 +556,7 @@ "description": [], "source": { "path": "src/plugins/expressions/common/execution/execution.ts", - "lineNumber": 374 + "lineNumber": 400 } } ], @@ -529,7 +564,7 @@ "returnComment": [], "source": { "path": "src/plugins/expressions/common/execution/execution.ts", - "lineNumber": 374 + "lineNumber": 400 } }, { @@ -545,7 +580,9 @@ "section": "def-common.ExpressionAstNode", "text": "ExpressionAstNode" }, - ", input: T) => Promise" + ", input: T) => ", + "Observable", + "" ], "description": [], "children": [ @@ -566,7 +603,7 @@ "description": [], "source": { "path": "src/plugins/expressions/common/execution/execution.ts", - "lineNumber": 465 + "lineNumber": 489 } }, { @@ -580,7 +617,7 @@ "description": [], "source": { "path": "src/plugins/expressions/common/execution/execution.ts", - "lineNumber": 465 + "lineNumber": 489 } } ], @@ -588,13 +625,13 @@ "returnComment": [], "source": { "path": "src/plugins/expressions/common/execution/execution.ts", - "lineNumber": 465 + "lineNumber": 489 } } ], "source": { "path": "src/plugins/expressions/common/execution/execution.ts", - "lineNumber": 70 + "lineNumber": 84 }, "initialIsOpen": false }, @@ -625,7 +662,7 @@ "description": [], "source": { "path": "src/plugins/expressions/common/execution/execution_contract.ts", - "lineNumber": 18 + "lineNumber": 20 } }, { @@ -655,7 +692,7 @@ "description": [], "source": { "path": "src/plugins/expressions/common/execution/execution_contract.ts", - "lineNumber": 24 + "lineNumber": 26 } } ], @@ -663,7 +700,7 @@ "returnComment": [], "source": { "path": "src/plugins/expressions/common/execution/execution_contract.ts", - "lineNumber": 24 + "lineNumber": 26 } }, { @@ -679,7 +716,7 @@ "label": "cancel", "source": { "path": "src/plugins/expressions/common/execution/execution_contract.ts", - "lineNumber": 31 + "lineNumber": 33 }, "tags": [], "returnComment": [] @@ -721,7 +758,7 @@ "label": "getData", "source": { "path": "src/plugins/expressions/common/execution/execution_contract.ts", - "lineNumber": 40 + "lineNumber": 42 }, "tags": [], "returnComment": [] @@ -739,7 +776,7 @@ "label": "getExpression", "source": { "path": "src/plugins/expressions/common/execution/execution_contract.ts", - "lineNumber": 60 + "lineNumber": 65 }, "tags": [], "returnComment": [] @@ -764,7 +801,7 @@ "label": "getAst", "source": { "path": "src/plugins/expressions/common/execution/execution_contract.ts", - "lineNumber": 67 + "lineNumber": 72 }, "tags": [], "returnComment": [] @@ -782,7 +819,7 @@ "label": "inspect", "source": { "path": "src/plugins/expressions/common/execution/execution_contract.ts", - "lineNumber": 73 + "lineNumber": 78 }, "tags": [], "returnComment": [] @@ -790,7 +827,7 @@ ], "source": { "path": "src/plugins/expressions/common/execution/execution_contract.ts", - "lineNumber": 17 + "lineNumber": 19 }, "initialIsOpen": false }, @@ -862,7 +899,7 @@ "description": [], "source": { "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 83 + "lineNumber": 84 } } ], @@ -870,7 +907,7 @@ "returnComment": [], "source": { "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 82 + "lineNumber": 83 } }, { @@ -881,7 +918,7 @@ "description": [], "source": { "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 91 + "lineNumber": 92 }, "signature": [ { @@ -904,7 +941,7 @@ "description": [], "source": { "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 96 + "lineNumber": 97 }, "signature": [ { @@ -926,7 +963,7 @@ "description": [], "source": { "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 101 + "lineNumber": 102 }, "signature": [ { @@ -965,7 +1002,7 @@ "description": [], "source": { "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 103 + "lineNumber": 104 } } ], @@ -973,7 +1010,7 @@ "returnComment": [], "source": { "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 103 + "lineNumber": 104 } }, { @@ -1027,7 +1064,7 @@ "description": [], "source": { "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 110 + "lineNumber": 111 } } ], @@ -1035,7 +1072,7 @@ "returnComment": [], "source": { "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 109 + "lineNumber": 110 } }, { @@ -1066,7 +1103,7 @@ "description": [], "source": { "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 118 + "lineNumber": 119 } } ], @@ -1074,7 +1111,7 @@ "returnComment": [], "source": { "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 118 + "lineNumber": 119 } }, { @@ -1098,7 +1135,7 @@ "returnComment": [], "source": { "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 122 + "lineNumber": 123 } }, { @@ -1152,7 +1189,7 @@ "description": [], "source": { "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 127 + "lineNumber": 128 } } ], @@ -1160,7 +1197,7 @@ "returnComment": [], "source": { "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 126 + "lineNumber": 127 } }, { @@ -1191,7 +1228,7 @@ "description": [], "source": { "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 135 + "lineNumber": 136 } } ], @@ -1199,7 +1236,7 @@ "returnComment": [], "source": { "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 135 + "lineNumber": 136 } }, { @@ -1223,7 +1260,7 @@ "returnComment": [], "source": { "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 139 + "lineNumber": 140 } }, { @@ -1246,7 +1283,7 @@ "description": [], "source": { "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 143 + "lineNumber": 144 } } ], @@ -1254,7 +1291,7 @@ "returnComment": [], "source": { "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 143 + "lineNumber": 144 } }, { @@ -1265,7 +1302,7 @@ "description": [], "source": { "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 147 + "lineNumber": 148 }, "signature": [ "Record" @@ -1292,7 +1329,24 @@ "section": "def-common.ExpressionExecutionParams", "text": "ExpressionExecutionParams" }, - ") => Promise" + ") => ", + "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" + } ], "description": [ "\nExecute expression and return result.\n" @@ -1318,7 +1372,7 @@ ], "source": { "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 160 + "lineNumber": 161 } }, { @@ -1334,7 +1388,7 @@ ], "source": { "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 161 + "lineNumber": 162 } }, { @@ -1354,7 +1408,7 @@ "description": [], "source": { "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 162 + "lineNumber": 163 } } ], @@ -1362,7 +1416,7 @@ "returnComment": [], "source": { "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 159 + "lineNumber": 160 } }, { @@ -1424,7 +1478,7 @@ "description": [], "source": { "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 170 + "lineNumber": 169 } }, { @@ -1444,7 +1498,7 @@ "description": [], "source": { "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 171 + "lineNumber": 170 } } ], @@ -1452,7 +1506,7 @@ "returnComment": [], "source": { "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 169 + "lineNumber": 168 } }, { @@ -1498,7 +1552,7 @@ "description": [], "source": { "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 217 + "lineNumber": 216 } }, { @@ -1513,7 +1567,7 @@ "description": [], "source": { "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 217 + "lineNumber": 216 } } ], @@ -1521,7 +1575,7 @@ "returnComment": [], "source": { "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 217 + "lineNumber": 216 } }, { @@ -1568,7 +1622,7 @@ "description": [], "source": { "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 230 + "lineNumber": 229 } } ], @@ -1576,7 +1630,7 @@ "returnComment": [], "source": { "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 230 + "lineNumber": 229 } }, { @@ -1613,7 +1667,7 @@ "description": [], "source": { "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 241 + "lineNumber": 240 } }, { @@ -1627,7 +1681,7 @@ "description": [], "source": { "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 241 + "lineNumber": 240 } } ], @@ -1635,7 +1689,7 @@ "returnComment": [], "source": { "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 241 + "lineNumber": 240 } }, { @@ -1679,7 +1733,7 @@ "description": [], "source": { "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 249 + "lineNumber": 248 } }, { @@ -1693,7 +1747,7 @@ "description": [], "source": { "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 249 + "lineNumber": 248 } } ], @@ -1701,7 +1755,7 @@ "returnComment": [], "source": { "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 249 + "lineNumber": 248 } }, { @@ -1725,13 +1779,13 @@ "returnComment": [], "source": { "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 258 + "lineNumber": 257 } } ], "source": { "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 80 + "lineNumber": 81 }, "initialIsOpen": false }, @@ -1778,7 +1832,7 @@ ], "source": { "path": "src/plugins/expressions/common/expression_functions/expression_function.ts", - "lineNumber": 22 + "lineNumber": 21 } }, { @@ -1791,7 +1845,7 @@ ], "source": { "path": "src/plugins/expressions/common/expression_functions/expression_function.ts", - "lineNumber": 27 + "lineNumber": 26 }, "signature": [ "string[]" @@ -1807,7 +1861,7 @@ ], "source": { "path": "src/plugins/expressions/common/expression_functions/expression_function.ts", - "lineNumber": 34 + "lineNumber": 33 } }, { @@ -1820,7 +1874,7 @@ ], "source": { "path": "src/plugins/expressions/common/expression_functions/expression_function.ts", - "lineNumber": 39 + "lineNumber": 38 }, "signature": [ "(input: any, params: Record, handlers: object) => any" @@ -1836,7 +1890,7 @@ ], "source": { "path": "src/plugins/expressions/common/expression_functions/expression_function.ts", - "lineNumber": 44 + "lineNumber": 43 } }, { @@ -1850,7 +1904,7 @@ "label": "args", "source": { "path": "src/plugins/expressions/common/expression_functions/expression_function.ts", - "lineNumber": 49 + "lineNumber": 48 } }, { @@ -1863,7 +1917,7 @@ ], "source": { "path": "src/plugins/expressions/common/expression_functions/expression_function.ts", - "lineNumber": 54 + "lineNumber": 53 }, "signature": [ "string[] | undefined" @@ -1877,7 +1931,7 @@ "description": [], "source": { "path": "src/plugins/expressions/common/expression_functions/expression_function.ts", - "lineNumber": 56 + "lineNumber": 55 } }, { @@ -1888,7 +1942,7 @@ "description": [], "source": { "path": "src/plugins/expressions/common/expression_functions/expression_function.ts", - "lineNumber": 57 + "lineNumber": 56 }, "signature": [ "(state: Record Promise" + " | undefined) => Promise" ], "description": [], "label": "run", "source": { "path": "src/plugins/expressions/common/service/expressions_services.ts", - "lineNumber": 230 + "lineNumber": 231 }, "tags": [], "returnComment": [] @@ -3735,7 +3789,7 @@ "description": [], "source": { "path": "src/plugins/expressions/common/service/expressions_services.ts", - "lineNumber": 233 + "lineNumber": 234 } } ], @@ -3754,7 +3808,7 @@ "label": "getFunction", "source": { "path": "src/plugins/expressions/common/service/expressions_services.ts", - "lineNumber": 233 + "lineNumber": 234 }, "tags": [], "returnComment": [] @@ -3780,7 +3834,7 @@ "label": "getFunctions", "source": { "path": "src/plugins/expressions/common/service/expressions_services.ts", - "lineNumber": 240 + "lineNumber": 241 }, "tags": [], "returnComment": [] @@ -3800,7 +3854,7 @@ "description": [], "source": { "path": "src/plugins/expressions/common/service/expressions_services.ts", - "lineNumber": 243 + "lineNumber": 244 } } ], @@ -3819,7 +3873,7 @@ "label": "getRenderer", "source": { "path": "src/plugins/expressions/common/service/expressions_services.ts", - "lineNumber": 243 + "lineNumber": 244 }, "tags": [], "returnComment": [] @@ -3845,7 +3899,7 @@ "label": "getRenderers", "source": { "path": "src/plugins/expressions/common/service/expressions_services.ts", - "lineNumber": 250 + "lineNumber": 251 }, "tags": [], "returnComment": [] @@ -3865,7 +3919,7 @@ "description": [], "source": { "path": "src/plugins/expressions/common/service/expressions_services.ts", - "lineNumber": 253 + "lineNumber": 254 } } ], @@ -3884,7 +3938,7 @@ "label": "getType", "source": { "path": "src/plugins/expressions/common/service/expressions_services.ts", - "lineNumber": 253 + "lineNumber": 254 }, "tags": [], "returnComment": [] @@ -3910,7 +3964,7 @@ "label": "getTypes", "source": { "path": "src/plugins/expressions/common/service/expressions_services.ts", - "lineNumber": 260 + "lineNumber": 261 }, "tags": [], "returnComment": [] @@ -3923,7 +3977,7 @@ "description": [], "source": { "path": "src/plugins/expressions/common/service/expressions_services.ts", - "lineNumber": 262 + "lineNumber": 263 }, "signature": [ "(ast: string | ", @@ -3971,7 +4025,7 @@ "label": "fork", "source": { "path": "src/plugins/expressions/common/service/expressions_services.ts", - "lineNumber": 268 + "lineNumber": 269 }, "tags": [], "returnComment": [] @@ -3997,7 +4051,7 @@ "description": [], "source": { "path": "src/plugins/expressions/common/service/expressions_services.ts", - "lineNumber": 281 + "lineNumber": 282 } }, { @@ -4011,7 +4065,7 @@ "description": [], "source": { "path": "src/plugins/expressions/common/service/expressions_services.ts", - "lineNumber": 282 + "lineNumber": 283 } } ], @@ -4032,7 +4086,7 @@ "label": "telemetry", "source": { "path": "src/plugins/expressions/common/service/expressions_services.ts", - "lineNumber": 280 + "lineNumber": 281 }, "tags": [], "returnComment": [] @@ -4058,7 +4112,7 @@ "description": [], "source": { "path": "src/plugins/expressions/common/service/expressions_services.ts", - "lineNumber": 292 + "lineNumber": 293 } } ], @@ -4089,7 +4143,7 @@ "label": "extract", "source": { "path": "src/plugins/expressions/common/service/expressions_services.ts", - "lineNumber": 292 + "lineNumber": 293 }, "tags": [], "returnComment": [ @@ -4117,7 +4171,7 @@ "description": [], "source": { "path": "src/plugins/expressions/common/service/expressions_services.ts", - "lineNumber": 302 + "lineNumber": 303 } }, { @@ -4132,7 +4186,7 @@ "description": [], "source": { "path": "src/plugins/expressions/common/service/expressions_services.ts", - "lineNumber": 302 + "lineNumber": 303 } } ], @@ -4162,7 +4216,7 @@ "label": "inject", "source": { "path": "src/plugins/expressions/common/service/expressions_services.ts", - "lineNumber": 302 + "lineNumber": 303 }, "tags": [], "returnComment": [ @@ -4190,7 +4244,7 @@ "description": [], "source": { "path": "src/plugins/expressions/common/service/expressions_services.ts", - "lineNumber": 312 + "lineNumber": 313 } }, { @@ -4204,7 +4258,7 @@ "description": [], "source": { "path": "src/plugins/expressions/common/service/expressions_services.ts", - "lineNumber": 312 + "lineNumber": 313 } } ], @@ -4232,7 +4286,7 @@ "label": "migrate", "source": { "path": "src/plugins/expressions/common/service/expressions_services.ts", - "lineNumber": 312 + "lineNumber": 313 }, "tags": [], "returnComment": [ @@ -4262,7 +4316,7 @@ "returnComment": [], "source": { "path": "src/plugins/expressions/common/service/expressions_services.ts", - "lineNumber": 320 + "lineNumber": 321 } }, { @@ -4287,7 +4341,7 @@ "returnComment": [], "source": { "path": "src/plugins/expressions/common/service/expressions_services.ts", - "lineNumber": 328 + "lineNumber": 329 } }, { @@ -4303,13 +4357,13 @@ "returnComment": [], "source": { "path": "src/plugins/expressions/common/service/expressions_services.ts", - "lineNumber": 332 + "lineNumber": 333 } } ], "source": { "path": "src/plugins/expressions/common/service/expressions_services.ts", - "lineNumber": 174 + "lineNumber": 175 }, "initialIsOpen": false }, @@ -4784,7 +4838,7 @@ "description": [], "source": { "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 59 + "lineNumber": 60 } } ], @@ -4792,7 +4846,7 @@ "returnComment": [], "source": { "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 59 + "lineNumber": 60 } }, { @@ -4846,7 +4900,7 @@ "description": [], "source": { "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 62 + "lineNumber": 63 } } ], @@ -4854,7 +4908,7 @@ "returnComment": [], "source": { "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 61 + "lineNumber": 62 } }, { @@ -4885,7 +4939,7 @@ "description": [], "source": { "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 67 + "lineNumber": 68 } } ], @@ -4893,7 +4947,7 @@ "returnComment": [], "source": { "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 67 + "lineNumber": 68 } }, { @@ -4917,7 +4971,7 @@ "returnComment": [], "source": { "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 71 + "lineNumber": 72 } }, { @@ -4941,13 +4995,13 @@ "returnComment": [], "source": { "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 75 + "lineNumber": 76 } } ], "source": { "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 58 + "lineNumber": 59 }, "initialIsOpen": false }, @@ -5117,7 +5171,7 @@ "description": [], "source": { "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 37 + "lineNumber": 38 } } ], @@ -5125,7 +5179,7 @@ "returnComment": [], "source": { "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 37 + "lineNumber": 38 } }, { @@ -5179,7 +5233,7 @@ "description": [], "source": { "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 40 + "lineNumber": 41 } } ], @@ -5187,7 +5241,7 @@ "returnComment": [], "source": { "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 39 + "lineNumber": 40 } }, { @@ -5218,7 +5272,7 @@ "description": [], "source": { "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 45 + "lineNumber": 46 } } ], @@ -5226,7 +5280,7 @@ "returnComment": [], "source": { "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 45 + "lineNumber": 46 } }, { @@ -5250,7 +5304,7 @@ "returnComment": [], "source": { "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 49 + "lineNumber": 50 } }, { @@ -5274,13 +5328,13 @@ "returnComment": [], "source": { "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 53 + "lineNumber": 54 } } ], "source": { "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 36 + "lineNumber": 37 }, "initialIsOpen": false } @@ -6104,7 +6158,7 @@ "description": [], "source": { "path": "src/plugins/expressions/common/execution/execution.ts", - "lineNumber": 58 + "lineNumber": 72 }, "signature": [ { @@ -6125,7 +6179,7 @@ "description": [], "source": { "path": "src/plugins/expressions/common/execution/execution.ts", - "lineNumber": 59 + "lineNumber": 73 }, "signature": [ { @@ -6146,7 +6200,7 @@ "description": [], "source": { "path": "src/plugins/expressions/common/execution/execution.ts", - "lineNumber": 60 + "lineNumber": 74 }, "signature": [ "string | undefined" @@ -6160,7 +6214,7 @@ "description": [], "source": { "path": "src/plugins/expressions/common/execution/execution.ts", - "lineNumber": 61 + "lineNumber": 75 }, "signature": [ { @@ -6175,7 +6229,7 @@ ], "source": { "path": "src/plugins/expressions/common/execution/execution.ts", - "lineNumber": 57 + "lineNumber": 71 }, "initialIsOpen": false }, @@ -7482,7 +7536,7 @@ ], "source": { "path": "src/plugins/expressions/common/service/expressions_services.ts", - "lineNumber": 78 + "lineNumber": 79 }, "signature": [ "(name: string) => ", @@ -7506,7 +7560,7 @@ ], "source": { "path": "src/plugins/expressions/common/service/expressions_services.ts", - "lineNumber": 86 + "lineNumber": 87 }, "signature": [ "(name: string) => ", @@ -7530,7 +7584,7 @@ ], "source": { "path": "src/plugins/expressions/common/service/expressions_services.ts", - "lineNumber": 94 + "lineNumber": 95 }, "signature": [ "(name: string) => ", @@ -7554,7 +7608,7 @@ ], "source": { "path": "src/plugins/expressions/common/service/expressions_services.ts", - "lineNumber": 120 + "lineNumber": 121 }, "signature": [ "(ast: string | ", @@ -7586,7 +7640,7 @@ ], "source": { "path": "src/plugins/expressions/common/service/expressions_services.ts", - "lineNumber": 131 + "lineNumber": 132 }, "signature": [ "(ast: string | ", @@ -7626,7 +7680,7 @@ ], "source": { "path": "src/plugins/expressions/common/service/expressions_services.ts", - "lineNumber": 147 + "lineNumber": 148 }, "signature": [ "() => ", @@ -7642,7 +7696,7 @@ ], "source": { "path": "src/plugins/expressions/common/service/expressions_services.ts", - "lineNumber": 71 + "lineNumber": 72 }, "initialIsOpen": false }, @@ -8730,7 +8784,7 @@ "description": [], "source": { "path": "src/plugins/expressions/common/types/common.ts", - "lineNumber": 54 + "lineNumber": 56 }, "signature": [ "string | undefined" @@ -8744,7 +8798,7 @@ "description": [], "source": { "path": "src/plugins/expressions/common/types/common.ts", - "lineNumber": 55 + "lineNumber": 57 }, "signature": [ "TParams | undefined" @@ -8753,7 +8807,7 @@ ], "source": { "path": "src/plugins/expressions/common/types/common.ts", - "lineNumber": 53 + "lineNumber": 55 }, "initialIsOpen": false } @@ -8903,7 +8957,7 @@ "lineNumber": 36 }, "signature": [ - "\"string\" | \"number\" | \"boolean\" | \"object\" | \"date\" | \"ip\" | \"_source\" | \"attachment\" | \"geo_point\" | \"geo_shape\" | \"murmur3\" | \"unknown\" | \"conflict\" | \"nested\" | \"histogram\" | \"null\"" + "\"string\" | \"number\" | \"boolean\" | \"object\" | \"date\" | \"ip\" | \"unknown\" | \"_source\" | \"attachment\" | \"geo_point\" | \"geo_shape\" | \"murmur3\" | \"conflict\" | \"nested\" | \"histogram\" | \"null\"" ], "initialIsOpen": false }, @@ -9409,7 +9463,7 @@ "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" + "(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" ], "initialIsOpen": false }, @@ -9448,7 +9502,7 @@ ], "source": { "path": "src/plugins/expressions/common/types/common.ts", - "lineNumber": 46 + "lineNumber": 48 }, "signature": [ "\"date\" | \"filter\"" @@ -9665,7 +9719,7 @@ ], "source": { "path": "src/plugins/expressions/common/execution/execution.ts", - "lineNumber": 80 + "lineNumber": 94 }, "signature": [ { @@ -9712,7 +9766,7 @@ ], "source": { "path": "src/plugins/expressions/common/execution/execution.ts", - "lineNumber": 88 + "lineNumber": 102 }, "signature": [ "Input" @@ -9728,7 +9782,7 @@ ], "source": { "path": "src/plugins/expressions/common/execution/execution.ts", - "lineNumber": 94 + "lineNumber": 113 }, "signature": [ { @@ -9745,50 +9799,19 @@ }, { "tags": [], - "id": "def-server.Execution.contract", + "id": "def-server.Execution.result", "type": "Object", - "label": "contract", + "label": "result", "description": [ - "\nContract is a public representation of `Execution` instances. Contract we\ncan return to other plugins for their consumption." + "\nFuture that tracks result or error of this execution." ], - "source": { - "path": "src/plugins/expressions/common/execution/execution.ts", - "lineNumber": 134 - }, - "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 - } - }, - { - "id": "def-server.Execution.result", - "type": "Object", - "label": "result", - "tags": [], - "description": [], - "source": { - "path": "src/plugins/expressions/common/execution/execution.ts", - "lineNumber": 142 }, "signature": [ - "Promise>" ] }, + { + "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": 153 + }, + "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": 159 + } + }, { "id": "def-server.Execution.inspectorAdapters", "type": "Uncategorized", @@ -9823,7 +9880,7 @@ "description": [], "source": { "path": "src/plugins/expressions/common/execution/execution.ts", - "lineNumber": 146 + "lineNumber": 161 }, "signature": [ "InspectorAdapters" @@ -9855,7 +9912,7 @@ "description": [], "source": { "path": "src/plugins/expressions/common/execution/execution.ts", - "lineNumber": 150 + "lineNumber": 165 } } ], @@ -9863,7 +9920,7 @@ "returnComment": [], "source": { "path": "src/plugins/expressions/common/execution/execution.ts", - "lineNumber": 150 + "lineNumber": 165 } }, { @@ -9881,7 +9938,7 @@ "returnComment": [], "source": { "path": "src/plugins/expressions/common/execution/execution.ts", - "lineNumber": 192 + "lineNumber": 229 } }, { @@ -9889,7 +9946,33 @@ "type": "Function", "label": "start", "signature": [ - "(input?: Input) => void" + "(input?: Input) => ", + "Observable", + ">" ], "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." @@ -9906,7 +9989,7 @@ "description": [], "source": { "path": "src/plugins/expressions/common/execution/execution.ts", - "lineNumber": 202 + "lineNumber": 239 } } ], @@ -9914,7 +9997,7 @@ "returnComment": [], "source": { "path": "src/plugins/expressions/common/execution/execution.ts", - "lineNumber": 202 + "lineNumber": 239 } }, { @@ -9930,7 +10013,9 @@ "section": "def-common.ExpressionAstFunction", "text": "ExpressionAstFunction" }, - "[], input: unknown) => Promise" + "[], input: unknown) => ", + "Observable", + "" ], "description": [], "children": [ @@ -9952,7 +10037,7 @@ "description": [], "source": { "path": "src/plugins/expressions/common/execution/execution.ts", - "lineNumber": 236 + "lineNumber": 263 } }, { @@ -9966,7 +10051,7 @@ "description": [], "source": { "path": "src/plugins/expressions/common/execution/execution.ts", - "lineNumber": 236 + "lineNumber": 263 } } ], @@ -9974,7 +10059,7 @@ "returnComment": [], "source": { "path": "src/plugins/expressions/common/execution/execution.ts", - "lineNumber": 236 + "lineNumber": 263 } }, { @@ -9990,7 +10075,9 @@ "section": "def-common.ExpressionFunction", "text": "ExpressionFunction" }, - ", input: unknown, args: Record) => Promise" + ", input: unknown, args: Record) => ", + "Observable", + "" ], "description": [], "children": [ @@ -10011,7 +10098,7 @@ "description": [], "source": { "path": "src/plugins/expressions/common/execution/execution.ts", - "lineNumber": 317 + "lineNumber": 337 } }, { @@ -10025,7 +10112,7 @@ "description": [], "source": { "path": "src/plugins/expressions/common/execution/execution.ts", - "lineNumber": 318 + "lineNumber": 338 } }, { @@ -10039,7 +10126,7 @@ "description": [], "source": { "path": "src/plugins/expressions/common/execution/execution.ts", - "lineNumber": 319 + "lineNumber": 339 } } ], @@ -10047,7 +10134,7 @@ "returnComment": [], "source": { "path": "src/plugins/expressions/common/execution/execution.ts", - "lineNumber": 316 + "lineNumber": 336 } }, { @@ -10070,7 +10157,7 @@ "description": [], "source": { "path": "src/plugins/expressions/common/execution/execution.ts", - "lineNumber": 348 + "lineNumber": 374 } }, { @@ -10084,7 +10171,7 @@ "description": [], "source": { "path": "src/plugins/expressions/common/execution/execution.ts", - "lineNumber": 348 + "lineNumber": 374 } } ], @@ -10092,7 +10179,7 @@ "returnComment": [], "source": { "path": "src/plugins/expressions/common/execution/execution.ts", - "lineNumber": 348 + "lineNumber": 374 } }, { @@ -10108,7 +10195,9 @@ "section": "def-common.ExpressionFunction", "text": "ExpressionFunction" }, - ", input: unknown, argAsts: any) => Promise" + ", input: unknown, argAsts: any) => ", + "Observable", + "" ], "description": [], "children": [ @@ -10129,7 +10218,7 @@ "description": [], "source": { "path": "src/plugins/expressions/common/execution/execution.ts", - "lineNumber": 374 + "lineNumber": 400 } }, { @@ -10143,7 +10232,7 @@ "description": [], "source": { "path": "src/plugins/expressions/common/execution/execution.ts", - "lineNumber": 374 + "lineNumber": 400 } }, { @@ -10157,7 +10246,7 @@ "description": [], "source": { "path": "src/plugins/expressions/common/execution/execution.ts", - "lineNumber": 374 + "lineNumber": 400 } } ], @@ -10165,7 +10254,7 @@ "returnComment": [], "source": { "path": "src/plugins/expressions/common/execution/execution.ts", - "lineNumber": 374 + "lineNumber": 400 } }, { @@ -10181,7 +10270,9 @@ "section": "def-common.ExpressionAstNode", "text": "ExpressionAstNode" }, - ", input: T) => Promise" + ", input: T) => ", + "Observable", + "" ], "description": [], "children": [ @@ -10202,7 +10293,7 @@ "description": [], "source": { "path": "src/plugins/expressions/common/execution/execution.ts", - "lineNumber": 465 + "lineNumber": 489 } }, { @@ -10216,7 +10307,7 @@ "description": [], "source": { "path": "src/plugins/expressions/common/execution/execution.ts", - "lineNumber": 465 + "lineNumber": 489 } } ], @@ -10224,13 +10315,13 @@ "returnComment": [], "source": { "path": "src/plugins/expressions/common/execution/execution.ts", - "lineNumber": 465 + "lineNumber": 489 } } ], "source": { "path": "src/plugins/expressions/common/execution/execution.ts", - "lineNumber": 70 + "lineNumber": 84 }, "initialIsOpen": false }, @@ -10302,7 +10393,7 @@ "description": [], "source": { "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 83 + "lineNumber": 84 } } ], @@ -10310,7 +10401,7 @@ "returnComment": [], "source": { "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 82 + "lineNumber": 83 } }, { @@ -10321,7 +10412,7 @@ "description": [], "source": { "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 91 + "lineNumber": 92 }, "signature": [ { @@ -10344,7 +10435,7 @@ "description": [], "source": { "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 96 + "lineNumber": 97 }, "signature": [ { @@ -10366,7 +10457,7 @@ "description": [], "source": { "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 101 + "lineNumber": 102 }, "signature": [ { @@ -10405,7 +10496,7 @@ "description": [], "source": { "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 103 + "lineNumber": 104 } } ], @@ -10413,7 +10504,7 @@ "returnComment": [], "source": { "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 103 + "lineNumber": 104 } }, { @@ -10467,7 +10558,7 @@ "description": [], "source": { "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 110 + "lineNumber": 111 } } ], @@ -10475,7 +10566,7 @@ "returnComment": [], "source": { "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 109 + "lineNumber": 110 } }, { @@ -10506,7 +10597,7 @@ "description": [], "source": { "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 118 + "lineNumber": 119 } } ], @@ -10514,7 +10605,7 @@ "returnComment": [], "source": { "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 118 + "lineNumber": 119 } }, { @@ -10538,7 +10629,7 @@ "returnComment": [], "source": { "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 122 + "lineNumber": 123 } }, { @@ -10592,7 +10683,7 @@ "description": [], "source": { "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 127 + "lineNumber": 128 } } ], @@ -10600,7 +10691,7 @@ "returnComment": [], "source": { "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 126 + "lineNumber": 127 } }, { @@ -10631,7 +10722,7 @@ "description": [], "source": { "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 135 + "lineNumber": 136 } } ], @@ -10639,7 +10730,7 @@ "returnComment": [], "source": { "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 135 + "lineNumber": 136 } }, { @@ -10663,7 +10754,7 @@ "returnComment": [], "source": { "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 139 + "lineNumber": 140 } }, { @@ -10686,7 +10777,7 @@ "description": [], "source": { "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 143 + "lineNumber": 144 } } ], @@ -10694,7 +10785,7 @@ "returnComment": [], "source": { "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 143 + "lineNumber": 144 } }, { @@ -10705,7 +10796,7 @@ "description": [], "source": { "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 147 + "lineNumber": 148 }, "signature": [ "Record" @@ -10732,7 +10823,24 @@ "section": "def-common.ExpressionExecutionParams", "text": "ExpressionExecutionParams" }, - ") => Promise" + ") => ", + "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" + } ], "description": [ "\nExecute expression and return result.\n" @@ -10758,7 +10866,7 @@ ], "source": { "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 160 + "lineNumber": 161 } }, { @@ -10774,7 +10882,7 @@ ], "source": { "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 161 + "lineNumber": 162 } }, { @@ -10794,7 +10902,7 @@ "description": [], "source": { "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 162 + "lineNumber": 163 } } ], @@ -10802,7 +10910,7 @@ "returnComment": [], "source": { "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 159 + "lineNumber": 160 } }, { @@ -10864,7 +10972,7 @@ "description": [], "source": { "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 170 + "lineNumber": 169 } }, { @@ -10884,7 +10992,7 @@ "description": [], "source": { "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 171 + "lineNumber": 170 } } ], @@ -10892,7 +11000,7 @@ "returnComment": [], "source": { "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 169 + "lineNumber": 168 } }, { @@ -10938,7 +11046,7 @@ "description": [], "source": { "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 217 + "lineNumber": 216 } }, { @@ -10953,7 +11061,7 @@ "description": [], "source": { "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 217 + "lineNumber": 216 } } ], @@ -10961,7 +11069,7 @@ "returnComment": [], "source": { "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 217 + "lineNumber": 216 } }, { @@ -11008,7 +11116,7 @@ "description": [], "source": { "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 230 + "lineNumber": 229 } } ], @@ -11016,7 +11124,7 @@ "returnComment": [], "source": { "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 230 + "lineNumber": 229 } }, { @@ -11053,7 +11161,7 @@ "description": [], "source": { "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 241 + "lineNumber": 240 } }, { @@ -11067,7 +11175,7 @@ "description": [], "source": { "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 241 + "lineNumber": 240 } } ], @@ -11075,7 +11183,7 @@ "returnComment": [], "source": { "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 241 + "lineNumber": 240 } }, { @@ -11119,7 +11227,7 @@ "description": [], "source": { "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 249 + "lineNumber": 248 } }, { @@ -11133,7 +11241,7 @@ "description": [], "source": { "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 249 + "lineNumber": 248 } } ], @@ -11141,7 +11249,7 @@ "returnComment": [], "source": { "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 249 + "lineNumber": 248 } }, { @@ -11165,13 +11273,13 @@ "returnComment": [], "source": { "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 258 + "lineNumber": 257 } } ], "source": { "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 80 + "lineNumber": 81 }, "initialIsOpen": false }, @@ -11218,7 +11326,7 @@ ], "source": { "path": "src/plugins/expressions/common/expression_functions/expression_function.ts", - "lineNumber": 22 + "lineNumber": 21 } }, { @@ -11231,7 +11339,7 @@ ], "source": { "path": "src/plugins/expressions/common/expression_functions/expression_function.ts", - "lineNumber": 27 + "lineNumber": 26 }, "signature": [ "string[]" @@ -11247,7 +11355,7 @@ ], "source": { "path": "src/plugins/expressions/common/expression_functions/expression_function.ts", - "lineNumber": 34 + "lineNumber": 33 } }, { @@ -11260,7 +11368,7 @@ ], "source": { "path": "src/plugins/expressions/common/expression_functions/expression_function.ts", - "lineNumber": 39 + "lineNumber": 38 }, "signature": [ "(input: any, params: Record, handlers: object) => any" @@ -11276,7 +11384,7 @@ ], "source": { "path": "src/plugins/expressions/common/expression_functions/expression_function.ts", - "lineNumber": 44 + "lineNumber": 43 } }, { @@ -11290,7 +11398,7 @@ "label": "args", "source": { "path": "src/plugins/expressions/common/expression_functions/expression_function.ts", - "lineNumber": 49 + "lineNumber": 48 } }, { @@ -11303,7 +11411,7 @@ ], "source": { "path": "src/plugins/expressions/common/expression_functions/expression_function.ts", - "lineNumber": 54 + "lineNumber": 53 }, "signature": [ "string[] | undefined" @@ -11317,7 +11425,7 @@ "description": [], "source": { "path": "src/plugins/expressions/common/expression_functions/expression_function.ts", - "lineNumber": 56 + "lineNumber": 55 } }, { @@ -11328,7 +11436,7 @@ "description": [], "source": { "path": "src/plugins/expressions/common/expression_functions/expression_function.ts", - "lineNumber": 57 + "lineNumber": 56 }, "signature": [ "(state: Record extends string ? \"string\" : UnwrapPromiseOrReturn extends boolean ? \"boolean\" : UnwrapPromiseOrReturn extends number ? \"number\" : UnwrapPromiseOrReturn extends null ? \"null\" : UnwrapPromiseOrReturn extends { type: string; } ? ({ type: string; } & UnwrapPromiseOrReturn)[\"type\"] : never" + "(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" ], "initialIsOpen": false }, @@ -16721,7 +16829,7 @@ ], "source": { "path": "src/plugins/expressions/common/types/common.ts", - "lineNumber": 46 + "lineNumber": 48 }, "signature": [ "\"date\" | \"filter\"" @@ -16831,7 +16939,7 @@ ], "source": { "path": "src/plugins/expressions/common/execution/execution.ts", - "lineNumber": 80 + "lineNumber": 94 }, "signature": [ { @@ -16878,7 +16986,7 @@ ], "source": { "path": "src/plugins/expressions/common/execution/execution.ts", - "lineNumber": 88 + "lineNumber": 102 }, "signature": [ "Input" @@ -16894,7 +17002,7 @@ ], "source": { "path": "src/plugins/expressions/common/execution/execution.ts", - "lineNumber": 94 + "lineNumber": 113 }, "signature": [ { @@ -16911,50 +17019,19 @@ }, { "tags": [], - "id": "def-common.Execution.contract", + "id": "def-common.Execution.result", "type": "Object", - "label": "contract", + "label": "result", "description": [ - "\nContract is a public representation of `Execution` instances. Contract we\ncan return to other plugins for their consumption." + "\nFuture that tracks result or error of this execution." ], - "source": { - "path": "src/plugins/expressions/common/execution/execution.ts", - "lineNumber": 134 - }, - "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 - } - }, - { - "id": "def-common.Execution.result", - "type": "Object", - "label": "result", - "tags": [], - "description": [], - "source": { - "path": "src/plugins/expressions/common/execution/execution.ts", - "lineNumber": 142 }, "signature": [ - "Promise>" ] }, + { + "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": 153 + }, + "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": 159 + } + }, { "id": "def-common.Execution.inspectorAdapters", "type": "Uncategorized", @@ -16989,7 +17100,7 @@ "description": [], "source": { "path": "src/plugins/expressions/common/execution/execution.ts", - "lineNumber": 146 + "lineNumber": 161 }, "signature": [ "InspectorAdapters" @@ -17021,7 +17132,7 @@ "description": [], "source": { "path": "src/plugins/expressions/common/execution/execution.ts", - "lineNumber": 150 + "lineNumber": 165 } } ], @@ -17029,7 +17140,7 @@ "returnComment": [], "source": { "path": "src/plugins/expressions/common/execution/execution.ts", - "lineNumber": 150 + "lineNumber": 165 } }, { @@ -17047,7 +17158,7 @@ "returnComment": [], "source": { "path": "src/plugins/expressions/common/execution/execution.ts", - "lineNumber": 192 + "lineNumber": 229 } }, { @@ -17055,7 +17166,33 @@ "type": "Function", "label": "start", "signature": [ - "(input?: Input) => void" + "(input?: Input) => ", + "Observable", + ">" ], "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." @@ -17072,7 +17209,7 @@ "description": [], "source": { "path": "src/plugins/expressions/common/execution/execution.ts", - "lineNumber": 202 + "lineNumber": 239 } } ], @@ -17080,7 +17217,7 @@ "returnComment": [], "source": { "path": "src/plugins/expressions/common/execution/execution.ts", - "lineNumber": 202 + "lineNumber": 239 } }, { @@ -17096,7 +17233,9 @@ "section": "def-common.ExpressionAstFunction", "text": "ExpressionAstFunction" }, - "[], input: unknown) => Promise" + "[], input: unknown) => ", + "Observable", + "" ], "description": [], "children": [ @@ -17118,7 +17257,7 @@ "description": [], "source": { "path": "src/plugins/expressions/common/execution/execution.ts", - "lineNumber": 236 + "lineNumber": 263 } }, { @@ -17132,7 +17271,7 @@ "description": [], "source": { "path": "src/plugins/expressions/common/execution/execution.ts", - "lineNumber": 236 + "lineNumber": 263 } } ], @@ -17140,7 +17279,7 @@ "returnComment": [], "source": { "path": "src/plugins/expressions/common/execution/execution.ts", - "lineNumber": 236 + "lineNumber": 263 } }, { @@ -17156,7 +17295,9 @@ "section": "def-common.ExpressionFunction", "text": "ExpressionFunction" }, - ", input: unknown, args: Record) => Promise" + ", input: unknown, args: Record) => ", + "Observable", + "" ], "description": [], "children": [ @@ -17177,7 +17318,7 @@ "description": [], "source": { "path": "src/plugins/expressions/common/execution/execution.ts", - "lineNumber": 317 + "lineNumber": 337 } }, { @@ -17191,7 +17332,7 @@ "description": [], "source": { "path": "src/plugins/expressions/common/execution/execution.ts", - "lineNumber": 318 + "lineNumber": 338 } }, { @@ -17205,7 +17346,7 @@ "description": [], "source": { "path": "src/plugins/expressions/common/execution/execution.ts", - "lineNumber": 319 + "lineNumber": 339 } } ], @@ -17213,7 +17354,7 @@ "returnComment": [], "source": { "path": "src/plugins/expressions/common/execution/execution.ts", - "lineNumber": 316 + "lineNumber": 336 } }, { @@ -17236,7 +17377,7 @@ "description": [], "source": { "path": "src/plugins/expressions/common/execution/execution.ts", - "lineNumber": 348 + "lineNumber": 374 } }, { @@ -17250,7 +17391,7 @@ "description": [], "source": { "path": "src/plugins/expressions/common/execution/execution.ts", - "lineNumber": 348 + "lineNumber": 374 } } ], @@ -17258,7 +17399,7 @@ "returnComment": [], "source": { "path": "src/plugins/expressions/common/execution/execution.ts", - "lineNumber": 348 + "lineNumber": 374 } }, { @@ -17274,7 +17415,9 @@ "section": "def-common.ExpressionFunction", "text": "ExpressionFunction" }, - ", input: unknown, argAsts: any) => Promise" + ", input: unknown, argAsts: any) => ", + "Observable", + "" ], "description": [], "children": [ @@ -17295,7 +17438,7 @@ "description": [], "source": { "path": "src/plugins/expressions/common/execution/execution.ts", - "lineNumber": 374 + "lineNumber": 400 } }, { @@ -17309,7 +17452,7 @@ "description": [], "source": { "path": "src/plugins/expressions/common/execution/execution.ts", - "lineNumber": 374 + "lineNumber": 400 } }, { @@ -17323,7 +17466,7 @@ "description": [], "source": { "path": "src/plugins/expressions/common/execution/execution.ts", - "lineNumber": 374 + "lineNumber": 400 } } ], @@ -17331,7 +17474,7 @@ "returnComment": [], "source": { "path": "src/plugins/expressions/common/execution/execution.ts", - "lineNumber": 374 + "lineNumber": 400 } }, { @@ -17347,7 +17490,9 @@ "section": "def-common.ExpressionAstNode", "text": "ExpressionAstNode" }, - ", input: T) => Promise" + ", input: T) => ", + "Observable", + "" ], "description": [], "children": [ @@ -17368,7 +17513,7 @@ "description": [], "source": { "path": "src/plugins/expressions/common/execution/execution.ts", - "lineNumber": 465 + "lineNumber": 489 } }, { @@ -17382,7 +17527,7 @@ "description": [], "source": { "path": "src/plugins/expressions/common/execution/execution.ts", - "lineNumber": 465 + "lineNumber": 489 } } ], @@ -17390,13 +17535,13 @@ "returnComment": [], "source": { "path": "src/plugins/expressions/common/execution/execution.ts", - "lineNumber": 465 + "lineNumber": 489 } } ], "source": { "path": "src/plugins/expressions/common/execution/execution.ts", - "lineNumber": 70 + "lineNumber": 84 }, "initialIsOpen": false }, @@ -17427,7 +17572,7 @@ "description": [], "source": { "path": "src/plugins/expressions/common/execution/execution_contract.ts", - "lineNumber": 18 + "lineNumber": 20 } }, { @@ -17457,7 +17602,7 @@ "description": [], "source": { "path": "src/plugins/expressions/common/execution/execution_contract.ts", - "lineNumber": 24 + "lineNumber": 26 } } ], @@ -17465,7 +17610,7 @@ "returnComment": [], "source": { "path": "src/plugins/expressions/common/execution/execution_contract.ts", - "lineNumber": 24 + "lineNumber": 26 } }, { @@ -17481,7 +17626,7 @@ "label": "cancel", "source": { "path": "src/plugins/expressions/common/execution/execution_contract.ts", - "lineNumber": 31 + "lineNumber": 33 }, "tags": [], "returnComment": [] @@ -17523,7 +17668,7 @@ "label": "getData", "source": { "path": "src/plugins/expressions/common/execution/execution_contract.ts", - "lineNumber": 40 + "lineNumber": 42 }, "tags": [], "returnComment": [] @@ -17541,7 +17686,7 @@ "label": "getExpression", "source": { "path": "src/plugins/expressions/common/execution/execution_contract.ts", - "lineNumber": 60 + "lineNumber": 65 }, "tags": [], "returnComment": [] @@ -17566,7 +17711,7 @@ "label": "getAst", "source": { "path": "src/plugins/expressions/common/execution/execution_contract.ts", - "lineNumber": 67 + "lineNumber": 72 }, "tags": [], "returnComment": [] @@ -17584,7 +17729,7 @@ "label": "inspect", "source": { "path": "src/plugins/expressions/common/execution/execution_contract.ts", - "lineNumber": 73 + "lineNumber": 78 }, "tags": [], "returnComment": [] @@ -17592,7 +17737,7 @@ ], "source": { "path": "src/plugins/expressions/common/execution/execution_contract.ts", - "lineNumber": 17 + "lineNumber": 19 }, "initialIsOpen": false }, @@ -17664,7 +17809,7 @@ "description": [], "source": { "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 83 + "lineNumber": 84 } } ], @@ -17672,7 +17817,7 @@ "returnComment": [], "source": { "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 82 + "lineNumber": 83 } }, { @@ -17683,7 +17828,7 @@ "description": [], "source": { "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 91 + "lineNumber": 92 }, "signature": [ { @@ -17706,7 +17851,7 @@ "description": [], "source": { "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 96 + "lineNumber": 97 }, "signature": [ { @@ -17728,7 +17873,7 @@ "description": [], "source": { "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 101 + "lineNumber": 102 }, "signature": [ { @@ -17767,7 +17912,7 @@ "description": [], "source": { "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 103 + "lineNumber": 104 } } ], @@ -17775,7 +17920,7 @@ "returnComment": [], "source": { "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 103 + "lineNumber": 104 } }, { @@ -17829,7 +17974,7 @@ "description": [], "source": { "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 110 + "lineNumber": 111 } } ], @@ -17837,7 +17982,7 @@ "returnComment": [], "source": { "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 109 + "lineNumber": 110 } }, { @@ -17868,7 +18013,7 @@ "description": [], "source": { "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 118 + "lineNumber": 119 } } ], @@ -17876,7 +18021,7 @@ "returnComment": [], "source": { "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 118 + "lineNumber": 119 } }, { @@ -17900,7 +18045,7 @@ "returnComment": [], "source": { "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 122 + "lineNumber": 123 } }, { @@ -17954,7 +18099,7 @@ "description": [], "source": { "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 127 + "lineNumber": 128 } } ], @@ -17962,7 +18107,7 @@ "returnComment": [], "source": { "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 126 + "lineNumber": 127 } }, { @@ -17993,7 +18138,7 @@ "description": [], "source": { "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 135 + "lineNumber": 136 } } ], @@ -18001,7 +18146,7 @@ "returnComment": [], "source": { "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 135 + "lineNumber": 136 } }, { @@ -18025,7 +18170,7 @@ "returnComment": [], "source": { "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 139 + "lineNumber": 140 } }, { @@ -18048,7 +18193,7 @@ "description": [], "source": { "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 143 + "lineNumber": 144 } } ], @@ -18056,7 +18201,7 @@ "returnComment": [], "source": { "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 143 + "lineNumber": 144 } }, { @@ -18067,7 +18212,7 @@ "description": [], "source": { "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 147 + "lineNumber": 148 }, "signature": [ "Record" @@ -18094,7 +18239,24 @@ "section": "def-common.ExpressionExecutionParams", "text": "ExpressionExecutionParams" }, - ") => Promise" + ") => ", + "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" + } ], "description": [ "\nExecute expression and return result.\n" @@ -18120,7 +18282,7 @@ ], "source": { "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 160 + "lineNumber": 161 } }, { @@ -18136,7 +18298,7 @@ ], "source": { "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 161 + "lineNumber": 162 } }, { @@ -18156,7 +18318,7 @@ "description": [], "source": { "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 162 + "lineNumber": 163 } } ], @@ -18164,7 +18326,7 @@ "returnComment": [], "source": { "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 159 + "lineNumber": 160 } }, { @@ -18226,7 +18388,7 @@ "description": [], "source": { "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 170 + "lineNumber": 169 } }, { @@ -18246,7 +18408,7 @@ "description": [], "source": { "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 171 + "lineNumber": 170 } } ], @@ -18254,7 +18416,7 @@ "returnComment": [], "source": { "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 169 + "lineNumber": 168 } }, { @@ -18300,7 +18462,7 @@ "description": [], "source": { "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 217 + "lineNumber": 216 } }, { @@ -18315,7 +18477,7 @@ "description": [], "source": { "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 217 + "lineNumber": 216 } } ], @@ -18323,7 +18485,7 @@ "returnComment": [], "source": { "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 217 + "lineNumber": 216 } }, { @@ -18370,7 +18532,7 @@ "description": [], "source": { "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 230 + "lineNumber": 229 } } ], @@ -18378,7 +18540,7 @@ "returnComment": [], "source": { "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 230 + "lineNumber": 229 } }, { @@ -18415,7 +18577,7 @@ "description": [], "source": { "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 241 + "lineNumber": 240 } }, { @@ -18429,7 +18591,7 @@ "description": [], "source": { "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 241 + "lineNumber": 240 } } ], @@ -18437,7 +18599,7 @@ "returnComment": [], "source": { "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 241 + "lineNumber": 240 } }, { @@ -18481,7 +18643,7 @@ "description": [], "source": { "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 249 + "lineNumber": 248 } }, { @@ -18495,7 +18657,7 @@ "description": [], "source": { "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 249 + "lineNumber": 248 } } ], @@ -18503,7 +18665,7 @@ "returnComment": [], "source": { "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 249 + "lineNumber": 248 } }, { @@ -18527,13 +18689,13 @@ "returnComment": [], "source": { "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 258 + "lineNumber": 257 } } ], "source": { "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 80 + "lineNumber": 81 }, "initialIsOpen": false }, @@ -18580,7 +18742,7 @@ ], "source": { "path": "src/plugins/expressions/common/expression_functions/expression_function.ts", - "lineNumber": 22 + "lineNumber": 21 } }, { @@ -18593,7 +18755,7 @@ ], "source": { "path": "src/plugins/expressions/common/expression_functions/expression_function.ts", - "lineNumber": 27 + "lineNumber": 26 }, "signature": [ "string[]" @@ -18609,7 +18771,7 @@ ], "source": { "path": "src/plugins/expressions/common/expression_functions/expression_function.ts", - "lineNumber": 34 + "lineNumber": 33 } }, { @@ -18622,7 +18784,7 @@ ], "source": { "path": "src/plugins/expressions/common/expression_functions/expression_function.ts", - "lineNumber": 39 + "lineNumber": 38 }, "signature": [ "(input: any, params: Record, handlers: object) => any" @@ -18638,7 +18800,7 @@ ], "source": { "path": "src/plugins/expressions/common/expression_functions/expression_function.ts", - "lineNumber": 44 + "lineNumber": 43 } }, { @@ -18652,7 +18814,7 @@ "label": "args", "source": { "path": "src/plugins/expressions/common/expression_functions/expression_function.ts", - "lineNumber": 49 + "lineNumber": 48 } }, { @@ -18665,7 +18827,7 @@ ], "source": { "path": "src/plugins/expressions/common/expression_functions/expression_function.ts", - "lineNumber": 54 + "lineNumber": 53 }, "signature": [ "string[] | undefined" @@ -18679,7 +18841,7 @@ "description": [], "source": { "path": "src/plugins/expressions/common/expression_functions/expression_function.ts", - "lineNumber": 56 + "lineNumber": 55 } }, { @@ -18690,7 +18852,7 @@ "description": [], "source": { "path": "src/plugins/expressions/common/expression_functions/expression_function.ts", - "lineNumber": 57 + "lineNumber": 56 }, "signature": [ "(state: Record Promise" + " | undefined) => Promise" ], "description": [], "label": "run", "source": { "path": "src/plugins/expressions/common/service/expressions_services.ts", - "lineNumber": 230 + "lineNumber": 231 }, "tags": [], "returnComment": [] @@ -19887,7 +20049,7 @@ "description": [], "source": { "path": "src/plugins/expressions/common/service/expressions_services.ts", - "lineNumber": 233 + "lineNumber": 234 } } ], @@ -19906,7 +20068,7 @@ "label": "getFunction", "source": { "path": "src/plugins/expressions/common/service/expressions_services.ts", - "lineNumber": 233 + "lineNumber": 234 }, "tags": [], "returnComment": [] @@ -19932,7 +20094,7 @@ "label": "getFunctions", "source": { "path": "src/plugins/expressions/common/service/expressions_services.ts", - "lineNumber": 240 + "lineNumber": 241 }, "tags": [], "returnComment": [] @@ -19952,7 +20114,7 @@ "description": [], "source": { "path": "src/plugins/expressions/common/service/expressions_services.ts", - "lineNumber": 243 + "lineNumber": 244 } } ], @@ -19971,7 +20133,7 @@ "label": "getRenderer", "source": { "path": "src/plugins/expressions/common/service/expressions_services.ts", - "lineNumber": 243 + "lineNumber": 244 }, "tags": [], "returnComment": [] @@ -19997,7 +20159,7 @@ "label": "getRenderers", "source": { "path": "src/plugins/expressions/common/service/expressions_services.ts", - "lineNumber": 250 + "lineNumber": 251 }, "tags": [], "returnComment": [] @@ -20017,7 +20179,7 @@ "description": [], "source": { "path": "src/plugins/expressions/common/service/expressions_services.ts", - "lineNumber": 253 + "lineNumber": 254 } } ], @@ -20036,7 +20198,7 @@ "label": "getType", "source": { "path": "src/plugins/expressions/common/service/expressions_services.ts", - "lineNumber": 253 + "lineNumber": 254 }, "tags": [], "returnComment": [] @@ -20062,7 +20224,7 @@ "label": "getTypes", "source": { "path": "src/plugins/expressions/common/service/expressions_services.ts", - "lineNumber": 260 + "lineNumber": 261 }, "tags": [], "returnComment": [] @@ -20075,7 +20237,7 @@ "description": [], "source": { "path": "src/plugins/expressions/common/service/expressions_services.ts", - "lineNumber": 262 + "lineNumber": 263 }, "signature": [ "(ast: string | ", @@ -20123,7 +20285,7 @@ "label": "fork", "source": { "path": "src/plugins/expressions/common/service/expressions_services.ts", - "lineNumber": 268 + "lineNumber": 269 }, "tags": [], "returnComment": [] @@ -20149,7 +20311,7 @@ "description": [], "source": { "path": "src/plugins/expressions/common/service/expressions_services.ts", - "lineNumber": 281 + "lineNumber": 282 } }, { @@ -20163,7 +20325,7 @@ "description": [], "source": { "path": "src/plugins/expressions/common/service/expressions_services.ts", - "lineNumber": 282 + "lineNumber": 283 } } ], @@ -20184,7 +20346,7 @@ "label": "telemetry", "source": { "path": "src/plugins/expressions/common/service/expressions_services.ts", - "lineNumber": 280 + "lineNumber": 281 }, "tags": [], "returnComment": [] @@ -20210,7 +20372,7 @@ "description": [], "source": { "path": "src/plugins/expressions/common/service/expressions_services.ts", - "lineNumber": 292 + "lineNumber": 293 } } ], @@ -20241,7 +20403,7 @@ "label": "extract", "source": { "path": "src/plugins/expressions/common/service/expressions_services.ts", - "lineNumber": 292 + "lineNumber": 293 }, "tags": [], "returnComment": [ @@ -20269,7 +20431,7 @@ "description": [], "source": { "path": "src/plugins/expressions/common/service/expressions_services.ts", - "lineNumber": 302 + "lineNumber": 303 } }, { @@ -20284,7 +20446,7 @@ "description": [], "source": { "path": "src/plugins/expressions/common/service/expressions_services.ts", - "lineNumber": 302 + "lineNumber": 303 } } ], @@ -20314,7 +20476,7 @@ "label": "inject", "source": { "path": "src/plugins/expressions/common/service/expressions_services.ts", - "lineNumber": 302 + "lineNumber": 303 }, "tags": [], "returnComment": [ @@ -20342,7 +20504,7 @@ "description": [], "source": { "path": "src/plugins/expressions/common/service/expressions_services.ts", - "lineNumber": 312 + "lineNumber": 313 } }, { @@ -20356,7 +20518,7 @@ "description": [], "source": { "path": "src/plugins/expressions/common/service/expressions_services.ts", - "lineNumber": 312 + "lineNumber": 313 } } ], @@ -20384,7 +20546,7 @@ "label": "migrate", "source": { "path": "src/plugins/expressions/common/service/expressions_services.ts", - "lineNumber": 312 + "lineNumber": 313 }, "tags": [], "returnComment": [ @@ -20414,7 +20576,7 @@ "returnComment": [], "source": { "path": "src/plugins/expressions/common/service/expressions_services.ts", - "lineNumber": 320 + "lineNumber": 321 } }, { @@ -20439,7 +20601,7 @@ "returnComment": [], "source": { "path": "src/plugins/expressions/common/service/expressions_services.ts", - "lineNumber": 328 + "lineNumber": 329 } }, { @@ -20455,13 +20617,13 @@ "returnComment": [], "source": { "path": "src/plugins/expressions/common/service/expressions_services.ts", - "lineNumber": 332 + "lineNumber": 333 } } ], "source": { "path": "src/plugins/expressions/common/service/expressions_services.ts", - "lineNumber": 174 + "lineNumber": 175 }, "initialIsOpen": false }, @@ -20936,7 +21098,7 @@ "description": [], "source": { "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 59 + "lineNumber": 60 } } ], @@ -20944,7 +21106,7 @@ "returnComment": [], "source": { "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 59 + "lineNumber": 60 } }, { @@ -20998,7 +21160,7 @@ "description": [], "source": { "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 62 + "lineNumber": 63 } } ], @@ -21006,7 +21168,7 @@ "returnComment": [], "source": { "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 61 + "lineNumber": 62 } }, { @@ -21037,7 +21199,7 @@ "description": [], "source": { "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 67 + "lineNumber": 68 } } ], @@ -21045,7 +21207,7 @@ "returnComment": [], "source": { "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 67 + "lineNumber": 68 } }, { @@ -21069,7 +21231,7 @@ "returnComment": [], "source": { "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 71 + "lineNumber": 72 } }, { @@ -21093,13 +21255,13 @@ "returnComment": [], "source": { "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 75 + "lineNumber": 76 } } ], "source": { "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 58 + "lineNumber": 59 }, "initialIsOpen": false }, @@ -21269,7 +21431,7 @@ "description": [], "source": { "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 37 + "lineNumber": 38 } } ], @@ -21277,7 +21439,7 @@ "returnComment": [], "source": { "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 37 + "lineNumber": 38 } }, { @@ -21331,7 +21493,7 @@ "description": [], "source": { "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 40 + "lineNumber": 41 } } ], @@ -21339,7 +21501,7 @@ "returnComment": [], "source": { "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 39 + "lineNumber": 40 } }, { @@ -21370,7 +21532,7 @@ "description": [], "source": { "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 45 + "lineNumber": 46 } } ], @@ -21378,7 +21540,7 @@ "returnComment": [], "source": { "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 45 + "lineNumber": 46 } }, { @@ -21402,7 +21564,7 @@ "returnComment": [], "source": { "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 49 + "lineNumber": 50 } }, { @@ -21426,13 +21588,13 @@ "returnComment": [], "source": { "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 53 + "lineNumber": 54 } } ], "source": { "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 36 + "lineNumber": 37 }, "initialIsOpen": false } @@ -23531,7 +23693,7 @@ "description": [], "source": { "path": "src/plugins/expressions/common/execution/execution.ts", - "lineNumber": 58 + "lineNumber": 72 }, "signature": [ { @@ -23552,7 +23714,7 @@ "description": [], "source": { "path": "src/plugins/expressions/common/execution/execution.ts", - "lineNumber": 59 + "lineNumber": 73 }, "signature": [ { @@ -23573,7 +23735,7 @@ "description": [], "source": { "path": "src/plugins/expressions/common/execution/execution.ts", - "lineNumber": 60 + "lineNumber": 74 }, "signature": [ "string | undefined" @@ -23587,7 +23749,7 @@ "description": [], "source": { "path": "src/plugins/expressions/common/execution/execution.ts", - "lineNumber": 61 + "lineNumber": 75 }, "signature": [ { @@ -23602,7 +23764,7 @@ ], "source": { "path": "src/plugins/expressions/common/execution/execution.ts", - "lineNumber": 57 + "lineNumber": 71 }, "initialIsOpen": false }, @@ -24507,7 +24669,7 @@ ], "source": { "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 33 + "lineNumber": 34 }, "signature": [ "boolean | undefined" @@ -24516,7 +24678,7 @@ ], "source": { "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 27 + "lineNumber": 28 }, "initialIsOpen": false }, @@ -24535,7 +24697,7 @@ "description": [], "source": { "path": "src/plugins/expressions/common/service/expressions_services.ts", - "lineNumber": 42 + "lineNumber": 43 }, "signature": [ { @@ -24556,7 +24718,7 @@ "description": [], "source": { "path": "src/plugins/expressions/common/service/expressions_services.ts", - "lineNumber": 44 + "lineNumber": 45 }, "signature": [ "Record | undefined" @@ -24572,7 +24734,7 @@ ], "source": { "path": "src/plugins/expressions/common/service/expressions_services.ts", - "lineNumber": 51 + "lineNumber": 52 }, "signature": [ "boolean | undefined" @@ -24588,7 +24750,7 @@ ], "source": { "path": "src/plugins/expressions/common/service/expressions_services.ts", - "lineNumber": 58 + "lineNumber": 59 }, "signature": [ { @@ -24609,7 +24771,7 @@ "description": [], "source": { "path": "src/plugins/expressions/common/service/expressions_services.ts", - "lineNumber": 60 + "lineNumber": 61 }, "signature": [ "string | undefined" @@ -24623,7 +24785,7 @@ "description": [], "source": { "path": "src/plugins/expressions/common/service/expressions_services.ts", - "lineNumber": 62 + "lineNumber": 63 }, "signature": [ "boolean | undefined" @@ -24637,7 +24799,7 @@ "description": [], "source": { "path": "src/plugins/expressions/common/service/expressions_services.ts", - "lineNumber": 64 + "lineNumber": 65 }, "signature": [ { @@ -24653,7 +24815,7 @@ ], "source": { "path": "src/plugins/expressions/common/service/expressions_services.ts", - "lineNumber": 41 + "lineNumber": 42 }, "initialIsOpen": false }, @@ -25281,7 +25443,7 @@ "description": [], "source": { "path": "src/plugins/expressions/common/service/expressions_services.ts", - "lineNumber": 151 + "lineNumber": 152 }, "signature": [ { @@ -25302,7 +25464,7 @@ "description": [], "source": { "path": "src/plugins/expressions/common/service/expressions_services.ts", - "lineNumber": 152 + "lineNumber": 153 }, "signature": [ { @@ -25318,7 +25480,7 @@ ], "source": { "path": "src/plugins/expressions/common/service/expressions_services.ts", - "lineNumber": 150 + "lineNumber": 151 }, "initialIsOpen": false }, @@ -25341,7 +25503,7 @@ ], "source": { "path": "src/plugins/expressions/common/service/expressions_services.ts", - "lineNumber": 78 + "lineNumber": 79 }, "signature": [ "(name: string) => ", @@ -25365,7 +25527,7 @@ ], "source": { "path": "src/plugins/expressions/common/service/expressions_services.ts", - "lineNumber": 86 + "lineNumber": 87 }, "signature": [ "(name: string) => ", @@ -25389,7 +25551,7 @@ ], "source": { "path": "src/plugins/expressions/common/service/expressions_services.ts", - "lineNumber": 94 + "lineNumber": 95 }, "signature": [ "(name: string) => ", @@ -25413,7 +25575,7 @@ ], "source": { "path": "src/plugins/expressions/common/service/expressions_services.ts", - "lineNumber": 120 + "lineNumber": 121 }, "signature": [ "(ast: string | ", @@ -25445,7 +25607,7 @@ ], "source": { "path": "src/plugins/expressions/common/service/expressions_services.ts", - "lineNumber": 131 + "lineNumber": 132 }, "signature": [ "(ast: string | ", @@ -25485,7 +25647,7 @@ ], "source": { "path": "src/plugins/expressions/common/service/expressions_services.ts", - "lineNumber": 147 + "lineNumber": 148 }, "signature": [ "() => ", @@ -25501,7 +25663,7 @@ ], "source": { "path": "src/plugins/expressions/common/service/expressions_services.ts", - "lineNumber": 71 + "lineNumber": 72 }, "initialIsOpen": false }, @@ -26003,7 +26165,7 @@ "description": [], "source": { "path": "src/plugins/expressions/common/expression_functions/specs/map_column.ts", - "lineNumber": 14 + "lineNumber": 16 }, "signature": [ "string | null | undefined" @@ -26017,19 +26179,13 @@ "description": [], "source": { "path": "src/plugins/expressions/common/expression_functions/specs/map_column.ts", - "lineNumber": 15 + "lineNumber": 17 } }, { - "tags": [], "id": "def-common.MapColumnArguments.expression", "type": "Function", "label": "expression", - "description": [], - "source": { - "path": "src/plugins/expressions/common/expression_functions/specs/map_column.ts", - "lineNumber": 16 - }, "signature": [ "((datatable: ", { @@ -26039,8 +26195,39 @@ "section": "def-common.Datatable", "text": "Datatable" }, - ") => Promise) | undefined" - ] + ") => ", + "Observable", + ") | undefined" + ], + "description": [], + "children": [ + { + "id": "def-common.MapColumnArguments.expression.$1", + "type": "Object", + "label": "datatable", + "isRequired": true, + "signature": [ + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.Datatable", + "text": "Datatable" + } + ], + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/specs/map_column.ts", + "lineNumber": 18 + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/specs/map_column.ts", + "lineNumber": 18 + } }, { "tags": [], @@ -26050,7 +26237,7 @@ "description": [], "source": { "path": "src/plugins/expressions/common/expression_functions/specs/map_column.ts", - "lineNumber": 17 + "lineNumber": 19 }, "signature": [ "string | null | undefined" @@ -26059,7 +26246,7 @@ ], "source": { "path": "src/plugins/expressions/common/expression_functions/specs/map_column.ts", - "lineNumber": 13 + "lineNumber": 15 }, "initialIsOpen": false }, @@ -26329,7 +26516,7 @@ "description": [], "source": { "path": "src/plugins/expressions/common/types/common.ts", - "lineNumber": 54 + "lineNumber": 56 }, "signature": [ "string | undefined" @@ -26343,7 +26530,7 @@ "description": [], "source": { "path": "src/plugins/expressions/common/types/common.ts", - "lineNumber": 55 + "lineNumber": 57 }, "signature": [ "TParams | undefined" @@ -26352,7 +26539,7 @@ ], "source": { "path": "src/plugins/expressions/common/types/common.ts", - "lineNumber": 53 + "lineNumber": 55 }, "initialIsOpen": false } @@ -26545,7 +26732,7 @@ "lineNumber": 36 }, "signature": [ - "\"string\" | \"number\" | \"boolean\" | \"object\" | \"date\" | \"ip\" | \"_source\" | \"attachment\" | \"geo_point\" | \"geo_shape\" | \"murmur3\" | \"unknown\" | \"conflict\" | \"nested\" | \"histogram\" | \"null\"" + "\"string\" | \"number\" | \"boolean\" | \"object\" | \"date\" | \"ip\" | \"unknown\" | \"_source\" | \"attachment\" | \"geo_point\" | \"geo_shape\" | \"murmur3\" | \"conflict\" | \"nested\" | \"histogram\" | \"null\"" ], "initialIsOpen": false }, @@ -27014,7 +27201,7 @@ ], "source": { "path": "src/plugins/expressions/common/service/expressions_services.ts", - "lineNumber": 26 + "lineNumber": 27 }, "signature": [ "{ readonly getType: (name: string) => ", @@ -27524,7 +27711,7 @@ "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" + "(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" ], "initialIsOpen": false }, @@ -27563,7 +27750,7 @@ ], "source": { "path": "src/plugins/expressions/common/types/common.ts", - "lineNumber": 46 + "lineNumber": 48 }, "signature": [ "\"date\" | \"filter\"" @@ -30397,7 +30584,7 @@ "description": [], "source": { "path": "src/plugins/expressions/common/expression_functions/specs/map_column.ts", - "lineNumber": 26 + "lineNumber": 28 }, "signature": [ "\"mapColumn\"" @@ -30411,7 +30598,7 @@ "description": [], "source": { "path": "src/plugins/expressions/common/expression_functions/specs/map_column.ts", - "lineNumber": 27 + "lineNumber": 29 }, "signature": [ "string[]" @@ -30425,7 +30612,7 @@ "description": [], "source": { "path": "src/plugins/expressions/common/expression_functions/specs/map_column.ts", - "lineNumber": 28 + "lineNumber": 30 }, "signature": [ "\"datatable\"" @@ -30439,7 +30626,7 @@ "description": [], "source": { "path": "src/plugins/expressions/common/expression_functions/specs/map_column.ts", - "lineNumber": 29 + "lineNumber": 31 }, "signature": [ "\"datatable\"[]" @@ -30453,7 +30640,7 @@ "description": [], "source": { "path": "src/plugins/expressions/common/expression_functions/specs/map_column.ts", - "lineNumber": 30 + "lineNumber": 32 } }, { @@ -30474,7 +30661,7 @@ "description": [], "source": { "path": "src/plugins/expressions/common/expression_functions/specs/map_column.ts", - "lineNumber": 42 + "lineNumber": 44 }, "signature": [ "(\"string\" | \"null\")[]" @@ -30488,7 +30675,7 @@ "description": [], "source": { "path": "src/plugins/expressions/common/expression_functions/specs/map_column.ts", - "lineNumber": 43 + "lineNumber": 45 } }, { @@ -30499,7 +30686,7 @@ "description": [], "source": { "path": "src/plugins/expressions/common/expression_functions/specs/map_column.ts", - "lineNumber": 47 + "lineNumber": 49 }, "signature": [ "false" @@ -30513,7 +30700,7 @@ "description": [], "source": { "path": "src/plugins/expressions/common/expression_functions/specs/map_column.ts", - "lineNumber": 48 + "lineNumber": 50 }, "signature": [ "null" @@ -30524,7 +30711,7 @@ "label": "id", "source": { "path": "src/plugins/expressions/common/expression_functions/specs/map_column.ts", - "lineNumber": 41 + "lineNumber": 43 } }, { @@ -30540,7 +30727,7 @@ "description": [], "source": { "path": "src/plugins/expressions/common/expression_functions/specs/map_column.ts", - "lineNumber": 51 + "lineNumber": 53 }, "signature": [ "\"string\"[]" @@ -30554,7 +30741,7 @@ "description": [], "source": { "path": "src/plugins/expressions/common/expression_functions/specs/map_column.ts", - "lineNumber": 52 + "lineNumber": 54 }, "signature": [ "string[]" @@ -30568,7 +30755,7 @@ "description": [], "source": { "path": "src/plugins/expressions/common/expression_functions/specs/map_column.ts", - "lineNumber": 53 + "lineNumber": 55 } }, { @@ -30579,7 +30766,7 @@ "description": [], "source": { "path": "src/plugins/expressions/common/expression_functions/specs/map_column.ts", - "lineNumber": 56 + "lineNumber": 58 }, "signature": [ "true" @@ -30590,7 +30777,7 @@ "label": "name", "source": { "path": "src/plugins/expressions/common/expression_functions/specs/map_column.ts", - "lineNumber": 50 + "lineNumber": 52 } }, { @@ -30606,7 +30793,7 @@ "description": [], "source": { "path": "src/plugins/expressions/common/expression_functions/specs/map_column.ts", - "lineNumber": 59 + "lineNumber": 61 }, "signature": [ "(\"boolean\" | \"string\" | \"number\" | \"null\")[]" @@ -30620,7 +30807,7 @@ "description": [], "source": { "path": "src/plugins/expressions/common/expression_functions/specs/map_column.ts", - "lineNumber": 60 + "lineNumber": 62 }, "signature": [ "false" @@ -30634,7 +30821,7 @@ "description": [], "source": { "path": "src/plugins/expressions/common/expression_functions/specs/map_column.ts", - "lineNumber": 61 + "lineNumber": 63 }, "signature": [ "string[]" @@ -30648,7 +30835,7 @@ "description": [], "source": { "path": "src/plugins/expressions/common/expression_functions/specs/map_column.ts", - "lineNumber": 62 + "lineNumber": 64 } }, { @@ -30659,7 +30846,7 @@ "description": [], "source": { "path": "src/plugins/expressions/common/expression_functions/specs/map_column.ts", - "lineNumber": 69 + "lineNumber": 71 }, "signature": [ "true" @@ -30670,7 +30857,7 @@ "label": "expression", "source": { "path": "src/plugins/expressions/common/expression_functions/specs/map_column.ts", - "lineNumber": 58 + "lineNumber": 60 } }, { @@ -30686,7 +30873,7 @@ "description": [], "source": { "path": "src/plugins/expressions/common/expression_functions/specs/map_column.ts", - "lineNumber": 72 + "lineNumber": 74 }, "signature": [ "(\"string\" | \"null\")[]" @@ -30700,7 +30887,7 @@ "description": [], "source": { "path": "src/plugins/expressions/common/expression_functions/specs/map_column.ts", - "lineNumber": 73 + "lineNumber": 75 } }, { @@ -30711,7 +30898,7 @@ "description": [], "source": { "path": "src/plugins/expressions/common/expression_functions/specs/map_column.ts", - "lineNumber": 77 + "lineNumber": 79 }, "signature": [ "false" @@ -30725,7 +30912,7 @@ "description": [], "source": { "path": "src/plugins/expressions/common/expression_functions/specs/map_column.ts", - "lineNumber": 78 + "lineNumber": 80 }, "signature": [ "null" @@ -30736,7 +30923,7 @@ "label": "copyMetaFrom", "source": { "path": "src/plugins/expressions/common/expression_functions/specs/map_column.ts", - "lineNumber": 71 + "lineNumber": 73 } } ], @@ -30744,7 +30931,7 @@ "label": "args", "source": { "path": "src/plugins/expressions/common/expression_functions/specs/map_column.ts", - "lineNumber": 40 + "lineNumber": 42 } }, { @@ -30768,7 +30955,7 @@ "description": [], "source": { "path": "src/plugins/expressions/common/expression_functions/specs/map_column.ts", - "lineNumber": 81 + "lineNumber": 83 } }, { @@ -30788,7 +30975,7 @@ "description": [], "source": { "path": "src/plugins/expressions/common/expression_functions/specs/map_column.ts", - "lineNumber": 81 + "lineNumber": 83 } } ], @@ -30823,7 +31010,7 @@ "label": "fn", "source": { "path": "src/plugins/expressions/common/expression_functions/specs/map_column.ts", - "lineNumber": 81 + "lineNumber": 83 }, "tags": [], "returnComment": [] @@ -30833,7 +31020,7 @@ "label": "mapColumn", "source": { "path": "src/plugins/expressions/common/expression_functions/specs/map_column.ts", - "lineNumber": 20 + "lineNumber": 22 }, "initialIsOpen": false }, diff --git a/api_docs/features.json b/api_docs/features.json index 3755e99beb3b0..46f6dedb000d5 100644 --- a/api_docs/features.json +++ b/api_docs/features.json @@ -2014,6 +2014,22 @@ "path": "x-pack/plugins/features/server/plugin.ts", "lineNumber": 48 } + }, + { + "id": "def-server.PluginSetupContract.enableReportingUiCapabilities", + "type": "Function", + "label": "enableReportingUiCapabilities", + "signature": [ + "() => void" + ], + "description": [], + "children": [], + "tags": [], + "returnComment": [], + "source": { + "path": "x-pack/plugins/features/server/plugin.ts", + "lineNumber": 56 + } } ], "source": { @@ -2050,7 +2066,7 @@ "returnComment": [], "source": { "path": "x-pack/plugins/features/server/plugin.ts", - "lineNumber": 52 + "lineNumber": 60 } }, { @@ -2074,13 +2090,13 @@ "returnComment": [], "source": { "path": "x-pack/plugins/features/server/plugin.ts", - "lineNumber": 53 + "lineNumber": 61 } } ], "source": { "path": "x-pack/plugins/features/server/plugin.ts", - "lineNumber": 51 + "lineNumber": 59 }, "initialIsOpen": false } diff --git a/api_docs/file_data_visualizer.json b/api_docs/file_data_visualizer.json new file mode 100644 index 0000000000000..ffc3ff3717fd0 --- /dev/null +++ b/api_docs/file_data_visualizer.json @@ -0,0 +1,290 @@ +{ + "id": "fileDataVisualizer", + "client": { + "classes": [], + "functions": [], + "interfaces": [], + "enums": [], + "misc": [], + "objects": [], + "start": { + "id": "def-public.FileDataVisualizerPluginStart", + "type": "Type", + "label": "FileDataVisualizerPluginStart", + "tags": [], + "description": [], + "source": { + "path": "x-pack/plugins/file_data_visualizer/public/plugin.ts", + "lineNumber": 33 + }, + "signature": [ + "{ getFileDataVisualizerComponent: typeof getFileDataVisualizerComponent; getMaxBytesFormatted: typeof getMaxBytesFormatted; }" + ], + "lifecycle": "start", + "initialIsOpen": true + } + }, + "server": { + "classes": [], + "functions": [], + "interfaces": [], + "enums": [], + "misc": [], + "objects": [] + }, + "common": { + "classes": [], + "functions": [], + "interfaces": [ + { + "id": "def-common.DataVisualizerTableState", + "type": "Interface", + "label": "DataVisualizerTableState", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.DataVisualizerTableState.pageSize", + "type": "number", + "label": "pageSize", + "description": [], + "source": { + "path": "x-pack/plugins/file_data_visualizer/common/types.ts", + "lineNumber": 15 + } + }, + { + "tags": [], + "id": "def-common.DataVisualizerTableState.pageIndex", + "type": "number", + "label": "pageIndex", + "description": [], + "source": { + "path": "x-pack/plugins/file_data_visualizer/common/types.ts", + "lineNumber": 16 + } + }, + { + "tags": [], + "id": "def-common.DataVisualizerTableState.sortField", + "type": "string", + "label": "sortField", + "description": [], + "source": { + "path": "x-pack/plugins/file_data_visualizer/common/types.ts", + "lineNumber": 17 + } + }, + { + "tags": [], + "id": "def-common.DataVisualizerTableState.sortDirection", + "type": "string", + "label": "sortDirection", + "description": [], + "source": { + "path": "x-pack/plugins/file_data_visualizer/common/types.ts", + "lineNumber": 18 + } + }, + { + "tags": [], + "id": "def-common.DataVisualizerTableState.visibleFieldTypes", + "type": "Array", + "label": "visibleFieldTypes", + "description": [], + "source": { + "path": "x-pack/plugins/file_data_visualizer/common/types.ts", + "lineNumber": 19 + }, + "signature": [ + "string[]" + ] + }, + { + "tags": [], + "id": "def-common.DataVisualizerTableState.visibleFieldNames", + "type": "Array", + "label": "visibleFieldNames", + "description": [], + "source": { + "path": "x-pack/plugins/file_data_visualizer/common/types.ts", + "lineNumber": 20 + }, + "signature": [ + "string[]" + ] + }, + { + "tags": [], + "id": "def-common.DataVisualizerTableState.showDistributions", + "type": "boolean", + "label": "showDistributions", + "description": [], + "source": { + "path": "x-pack/plugins/file_data_visualizer/common/types.ts", + "lineNumber": 21 + } + } + ], + "source": { + "path": "x-pack/plugins/file_data_visualizer/common/types.ts", + "lineNumber": 14 + }, + "initialIsOpen": false + } + ], + "enums": [], + "misc": [ + { + "tags": [], + "id": "def-common.ABSOLUTE_MAX_FILE_SIZE_BYTES", + "type": "number", + "label": "ABSOLUTE_MAX_FILE_SIZE_BYTES", + "description": [], + "source": { + "path": "x-pack/plugins/file_data_visualizer/common/constants.ts", + "lineNumber": 14 + }, + "signature": [ + "1073741274" + ], + "initialIsOpen": false + }, + { + "tags": [], + "id": "def-common.FILE_SIZE_DISPLAY_FORMAT", + "type": "string", + "label": "FILE_SIZE_DISPLAY_FORMAT", + "description": [], + "source": { + "path": "x-pack/plugins/file_data_visualizer/common/constants.ts", + "lineNumber": 15 + }, + "signature": [ + "\"0,0.[0] b\"" + ], + "initialIsOpen": false + }, + { + "tags": [], + "id": "def-common.INDEX_META_DATA_CREATED_BY", + "type": "string", + "label": "INDEX_META_DATA_CREATED_BY", + "description": [], + "source": { + "path": "x-pack/plugins/file_data_visualizer/common/constants.ts", + "lineNumber": 19 + }, + "signature": [ + "\"file-data-visualizer\"" + ], + "initialIsOpen": false + }, + { + "id": "def-common.InputData", + "type": "Type", + "label": "InputData", + "tags": [], + "description": [], + "source": { + "path": "x-pack/plugins/file_data_visualizer/common/types.ts", + "lineNumber": 10 + }, + "signature": [ + "any[]" + ], + "initialIsOpen": false + }, + { + "id": "def-common.JobFieldType", + "type": "Type", + "label": "JobFieldType", + "tags": [], + "description": [], + "source": { + "path": "x-pack/plugins/file_data_visualizer/common/types.ts", + "lineNumber": 12 + }, + "signature": [ + "\"number\" | \"boolean\" | \"date\" | \"text\" | \"keyword\" | \"ip\" | \"unknown\" | \"geo_point\" | \"geo_shape\"" + ], + "initialIsOpen": false + }, + { + "tags": [], + "id": "def-common.MAX_FILE_SIZE", + "type": "string", + "label": "MAX_FILE_SIZE", + "description": [], + "source": { + "path": "x-pack/plugins/file_data_visualizer/common/constants.ts", + "lineNumber": 11 + }, + "signature": [ + "\"100MB\"" + ], + "initialIsOpen": false + }, + { + "tags": [], + "id": "def-common.MAX_FILE_SIZE_BYTES", + "type": "number", + "label": "MAX_FILE_SIZE_BYTES", + "description": [], + "source": { + "path": "x-pack/plugins/file_data_visualizer/common/constants.ts", + "lineNumber": 12 + }, + "signature": [ + "104857600" + ], + "initialIsOpen": false + }, + { + "tags": [], + "id": "def-common.MB", + "type": "number", + "label": "MB", + "description": [], + "source": { + "path": "x-pack/plugins/file_data_visualizer/common/constants.ts", + "lineNumber": 10 + }, + "initialIsOpen": false + }, + { + "tags": [], + "id": "def-common.UI_SETTING_MAX_FILE_SIZE", + "type": "string", + "label": "UI_SETTING_MAX_FILE_SIZE", + "description": [], + "source": { + "path": "x-pack/plugins/file_data_visualizer/common/constants.ts", + "lineNumber": 8 + }, + "signature": [ + "\"fileUpload:maxFileSize\"" + ], + "initialIsOpen": false + } + ], + "objects": [ + { + "tags": [], + "id": "def-common.JOB_FIELD_TYPES", + "type": "Object", + "label": "JOB_FIELD_TYPES", + "description": [], + "source": { + "path": "x-pack/plugins/file_data_visualizer/common/constants.ts", + "lineNumber": 21 + }, + "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\"; }" + ], + "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..a6c1f0c6488cf 100644 --- a/api_docs/file_upload.json +++ b/api_docs/file_upload.json @@ -4,61 +4,6 @@ "classes": [], "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 - }, { "id": "def-public.CreateDocsResponse", "type": "Interface", @@ -130,31 +75,6 @@ }, "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 - } - } - ], - "source": { - "path": "x-pack/plugins/file_upload/common/types.ts", - "lineNumber": 99 - }, - "initialIsOpen": false - }, { "id": "def-public.FileUploadComponentProps", "type": "Interface", @@ -170,18 +90,18 @@ "description": [], "source": { "path": "x-pack/plugins/file_upload/public/lazy_load_bundle/index.ts", - "lineNumber": 16 + "lineNumber": 24 } }, { "tags": [], - "id": "def-public.FileUploadComponentProps.onFileUpload", + "id": "def-public.FileUploadComponentProps.onFileSelect", "type": "Function", - "label": "onFileUpload", + "label": "onFileSelect", "description": [], "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" @@ -189,13 +109,13 @@ }, { "tags": [], - "id": "def-public.FileUploadComponentProps.onFileRemove", + "id": "def-public.FileUploadComponentProps.onFileClear", "type": "Function", - "label": "onFileRemove", + "label": "onFileClear", "description": [], "source": { "path": "x-pack/plugins/file_upload/public/lazy_load_bundle/index.ts", - "lineNumber": 18 + "lineNumber": 26 }, "signature": [ "() => void" @@ -203,57 +123,63 @@ }, { "tags": [], - "id": "def-public.FileUploadComponentProps.onIndexReady", + "id": "def-public.FileUploadComponentProps.enableImportBtn", "type": "Function", - "label": "onIndexReady", + "label": "enableImportBtn", "description": [], "source": { "path": "x-pack/plugins/file_upload/public/lazy_load_bundle/index.ts", - "lineNumber": 19 + "lineNumber": 27 }, "signature": [ - "(indexReady: boolean) => void" + "() => void" ] }, { "tags": [], - "id": "def-public.FileUploadComponentProps.onIndexingComplete", + "id": "def-public.FileUploadComponentProps.disableImportBtn", "type": "Function", - "label": "onIndexingComplete", + "label": "disableImportBtn", "description": [], "source": { "path": "x-pack/plugins/file_upload/public/lazy_load_bundle/index.ts", - "lineNumber": 20 + "lineNumber": 28 + }, + "signature": [ + "() => void" + ] + }, + { + "tags": [], + "id": "def-public.FileUploadComponentProps.onUploadComplete", + "type": "Function", + "label": "onUploadComplete", + "description": [], + "source": { + "path": "x-pack/plugins/file_upload/public/lazy_load_bundle/index.ts", + "lineNumber": 29 }, "signature": [ - "(results: { indexDataResp: ", + "(results: ", { "pluginId": "fileUpload", "scope": "public", "docId": "kibFileUploadPluginApi", - "section": "def-public.ImportResults", - "text": "ImportResults" + "section": "def-public.FileUploadGeoResults", + "text": "FileUploadGeoResults" }, - "; indexPattern: ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataIndexPatternsPluginApi", - "section": "def-common.IndexPattern", - "text": "IndexPattern" - }, - "; }) => void" + ") => void" ] }, { "tags": [], - "id": "def-public.FileUploadComponentProps.onIndexingError", + "id": "def-public.FileUploadComponentProps.onUploadError", "type": "Function", - "label": "onIndexingError", + "label": "onUploadError", "description": [], "source": { "path": "x-pack/plugins/file_upload/public/lazy_load_bundle/index.ts", - "lineNumber": 24 + "lineNumber": 30 }, "signature": [ "() => void" @@ -262,125 +188,50 @@ ], "source": { "path": "x-pack/plugins/file_upload/public/lazy_load_bundle/index.ts", - "lineNumber": 15 + "lineNumber": 23 }, "initialIsOpen": false }, { - "id": "def-public.FindFileStructureResponse", + "id": "def-public.FileUploadGeoResults", "type": "Interface", - "label": "FindFileStructureResponse", + "label": "FileUploadGeoResults", "description": [], "tags": [], "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", + "id": "def-public.FileUploadGeoResults.indexPatternId", "type": "string", - "label": "format", + "label": "indexPatternId", "description": [], "source": { - "path": "x-pack/plugins/file_upload/common/types.ts", - "lineNumber": 34 + "path": "x-pack/plugins/file_upload/public/lazy_load_bundle/index.ts", + "lineNumber": 17 } }, { "tags": [], - "id": "def-public.FindFileStructureResponse.field_stats", - "type": "Object", - "label": "field_stats", - "description": [], - "source": { - "path": "x-pack/plugins/file_upload/common/types.ts", - "lineNumber": 35 - }, - "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; }; }" - ] - }, - { - "tags": [], - "id": "def-public.FindFileStructureResponse.sample_start", + "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 } }, { "tags": [], - "id": "def-public.FindFileStructureResponse.mappings", - "type": "Object", - "label": "mappings", + "id": "def-public.FileUploadGeoResults.geoFieldType", + "type": "CompoundType", + "label": "geoFieldType", "description": [], "source": { - "path": "x-pack/plugins/file_upload/common/types.ts", - "lineNumber": 50 + "path": "x-pack/plugins/file_upload/public/lazy_load_bundle/index.ts", + "lineNumber": 19 }, "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", - "docId": "kibDataPluginApi", - "section": "def-common.ES_FIELD_TYPES", - "text": "ES_FIELD_TYPES" - }, - ".TEXT | ", { "pluginId": "data", "scope": "common", @@ -388,7 +239,7 @@ "section": "def-common.ES_FIELD_TYPES", "text": "ES_FIELD_TYPES" }, - ".KEYWORD | ", + ".GEO_POINT | ", { "pluginId": "data", "scope": "common", @@ -396,254 +247,63 @@ "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" - } + ".GEO_SHAPE" ] }, { "tags": [], - "id": "def-public.FindFileStructureResponse.quote", - "type": "string", - "label": "quote", + "id": "def-public.FileUploadGeoResults.docCount", + "type": "number", + "label": "docCount", "description": [], "source": { - "path": "x-pack/plugins/file_upload/common/types.ts", - "lineNumber": 63 + "path": "x-pack/plugins/file_upload/public/lazy_load_bundle/index.ts", + "lineNumber": 20 } - }, + } + ], + "source": { + "path": "x-pack/plugins/file_upload/public/lazy_load_bundle/index.ts", + "lineNumber": 16 + }, + "initialIsOpen": false + }, + { + "id": "def-public.IImporter", + "type": "Interface", + "label": "IImporter", + "description": [], + "tags": [], + "children": [ { - "tags": [], - "id": "def-public.FindFileStructureResponse.delimiter", - "type": "string", - "label": "delimiter", + "id": "def-public.IImporter.read", + "type": "Function", + "label": "read", + "signature": [ + "(data: ArrayBuffer) => { success: boolean; }" + ], "description": [], + "children": [ + { + "id": "def-public.IImporter.read.$1", + "type": "Object", + "label": "data", + "isRequired": true, + "signature": [ + "ArrayBuffer" + ], + "description": [], + "source": { + "path": "x-pack/plugins/file_upload/public/importer/types.ts", + "lineNumber": 44 + } + } + ], + "tags": [], + "returnComment": [], "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": [], - "source": { - "path": "x-pack/plugins/file_upload/common/types.ts", - "lineNumber": 74 - }, - "signature": [ - "string | undefined" - ] - }, - { - "tags": [], - "id": "def-public.FindFileStructureResponse.should_trim_fields", - "type": "CompoundType", - "label": "should_trim_fields", - "description": [], - "source": { - "path": "x-pack/plugins/file_upload/common/types.ts", - "lineNumber": 75 - }, - "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 - } - } - ], - "source": { - "path": "x-pack/plugins/file_upload/common/types.ts", - "lineNumber": 11 - }, - "initialIsOpen": false - }, - { - "id": "def-public.IImporter", - "type": "Interface", - "label": "IImporter", - "description": [], - "tags": [], - "children": [ - { - "id": "def-public.IImporter.read", - "type": "Function", - "label": "read", - "signature": [ - "(data: ArrayBuffer) => { success: boolean; }" - ], - "description": [], - "children": [ - { - "id": "def-public.IImporter.read.$1", - "type": "Object", - "label": "data", - "isRequired": true, - "signature": [ - "ArrayBuffer" - ], - "description": [], - "source": { - "path": "x-pack/plugins/file_upload/public/importer/types.ts", - "lineNumber": 44 - } - } - ], - "tags": [], - "returnComment": [], - "source": { - "path": "x-pack/plugins/file_upload/public/importer/types.ts", - "lineNumber": 44 + "path": "x-pack/plugins/file_upload/public/importer/types.ts", + "lineNumber": 44 } }, { @@ -993,188 +653,6 @@ }, "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 - }, - "signature": [ - "boolean | undefined" - ] - } - ], - "source": { - "path": "x-pack/plugins/file_upload/common/types.ts", - "lineNumber": 80 - }, - "initialIsOpen": false - }, { "id": "def-public.ImportResults", "type": "Interface", @@ -1250,175 +728,32 @@ "initialIsOpen": false }, { - "id": "def-public.IngestPipeline", + "id": "def-public.Props", "type": "Interface", - "label": "IngestPipeline", + "label": "Props", "description": [], "tags": [], "children": [ { "tags": [], - "id": "def-public.IngestPipeline.description", + "id": "def-public.Props.indexName", "type": "string", - "label": "description", - "description": [], - "source": { - "path": "x-pack/plugins/file_upload/common/types.ts", - "lineNumber": 127 - } - }, - { - "tags": [], - "id": "def-public.IngestPipeline.processors", - "type": "Array", - "label": "processors", + "label": "indexName", "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": [], - "source": { - "path": "x-pack/plugins/file_upload/common/types.ts", - "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" - ] - }, - { - "tags": [], - "id": "def-public.Mappings.properties", - "type": "Object", - "label": "properties", - "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": [ + "path": "x-pack/plugins/file_upload/public/components/geojson_upload_form/index_name_form.tsx", + "lineNumber": 15 + } + }, { "tags": [], - "id": "def-public.Settings.pipeline", + "id": "def-public.Props.indexNameError", "type": "string", - "label": "pipeline", + "label": "indexNameError", "description": [], "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": 16 }, "signature": [ "string | undefined" @@ -1426,208 +761,56 @@ }, { "tags": [], - "id": "def-public.Settings.index", - "type": "string", - "label": "index", + "id": "def-public.Props.onIndexNameChange", + "type": "Function", + "label": "onIndexNameChange", "description": [], "source": { - "path": "x-pack/plugins/file_upload/common/types.ts", - "lineNumber": 107 - } + "path": "x-pack/plugins/file_upload/public/components/geojson_upload_form/index_name_form.tsx", + "lineNumber": 17 + }, + "signature": [ + "(name: string, error?: string | undefined) => void" + ] }, { "tags": [], - "id": "def-public.Settings.body", - "type": "Array", - "label": "body", + "id": "def-public.Props.onIndexNameValidationStart", + "type": "Function", + "label": "onIndexNameValidationStart", "description": [], "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[]" + "() => void" ] }, { - "id": "def-public.Settings.Unnamed", - "type": "Any", - "label": "Unnamed", "tags": [], + "id": "def-public.Props.onIndexNameValidationEnd", + "type": "Function", + "label": "onIndexNameValidationEnd", "description": [], "source": { - "path": "x-pack/plugins/file_upload/common/types.ts", - "lineNumber": 109 + "path": "x-pack/plugins/file_upload/public/components/geojson_upload_form/index_name_form.tsx", + "lineNumber": 19 }, "signature": [ - "any" + "() => void" ] } ], "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", + "path": "x-pack/plugins/file_upload/public/components/geojson_upload_form/index_name_form.tsx", "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\"" - ], "initialIsOpen": false } ], + "enums": [], + "misc": [], "objects": [], "start": { "id": "def-public.FileUploadPluginStart", @@ -1637,7 +820,7 @@ "description": [], "source": { "path": "x-pack/plugins/file_upload/public/plugin.ts", - "lineNumber": 26 + "lineNumber": 30 }, "signature": [ "FileUploadStartApi" @@ -1673,7 +856,7 @@ "description": [], "source": { "path": "x-pack/plugins/file_upload/common/types.ts", - "lineNumber": 26 + "lineNumber": 22 }, "signature": [ { @@ -1693,7 +876,7 @@ "description": [], "source": { "path": "x-pack/plugins/file_upload/common/types.ts", - "lineNumber": 27 + "lineNumber": 23 }, "signature": [ { @@ -1709,7 +892,7 @@ ], "source": { "path": "x-pack/plugins/file_upload/common/types.ts", - "lineNumber": 25 + "lineNumber": 21 }, "initialIsOpen": false }, @@ -1728,13 +911,52 @@ "description": [], "source": { "path": "x-pack/plugins/file_upload/common/types.ts", - "lineNumber": 100 + "lineNumber": 118 + } + } + ], + "source": { + "path": "x-pack/plugins/file_upload/common/types.ts", + "lineNumber": 117 + }, + "initialIsOpen": false + }, + { + "id": "def-common.FindFileStructureErrorResponse", + "type": "Interface", + "label": "FindFileStructureErrorResponse", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.FindFileStructureErrorResponse.body", + "type": "Object", + "label": "body", + "description": [], + "source": { + "path": "x-pack/plugins/file_upload/common/types.ts", + "lineNumber": 75 + }, + "signature": [ + "{ statusCode: number; error: string; message: string; attributes?: ErrorAttribute | undefined; }" + ] + }, + { + "tags": [], + "id": "def-common.FindFileStructureErrorResponse.name", + "type": "string", + "label": "name", + "description": [], + "source": { + "path": "x-pack/plugins/file_upload/common/types.ts", + "lineNumber": 81 } } ], "source": { "path": "x-pack/plugins/file_upload/common/types.ts", - "lineNumber": 99 + "lineNumber": 74 }, "initialIsOpen": false }, @@ -1753,7 +975,7 @@ "description": [], "source": { "path": "x-pack/plugins/file_upload/common/types.ts", - "lineNumber": 31 + "lineNumber": 27 } }, { @@ -1764,7 +986,7 @@ "description": [], "source": { "path": "x-pack/plugins/file_upload/common/types.ts", - "lineNumber": 32 + "lineNumber": 28 } }, { @@ -1775,7 +997,7 @@ "description": [], "source": { "path": "x-pack/plugins/file_upload/common/types.ts", - "lineNumber": 33 + "lineNumber": 29 } }, { @@ -1786,7 +1008,7 @@ "description": [], "source": { "path": "x-pack/plugins/file_upload/common/types.ts", - "lineNumber": 34 + "lineNumber": 30 } }, { @@ -1797,7 +1019,7 @@ "description": [], "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; }; }" @@ -1811,7 +1033,7 @@ "description": [], "source": { "path": "x-pack/plugins/file_upload/common/types.ts", - "lineNumber": 48 + "lineNumber": 44 } }, { @@ -1822,7 +1044,7 @@ "description": [], "source": { "path": "x-pack/plugins/file_upload/common/types.ts", - "lineNumber": 49 + "lineNumber": 45 } }, { @@ -1833,7 +1055,7 @@ "description": [], "source": { "path": "x-pack/plugins/file_upload/common/types.ts", - "lineNumber": 50 + "lineNumber": 46 }, "signature": [ "{ properties: { [fieldName: string]: { type: ", @@ -1886,7 +1108,7 @@ "description": [], "source": { "path": "x-pack/plugins/file_upload/common/types.ts", - "lineNumber": 63 + "lineNumber": 59 } }, { @@ -1897,7 +1119,7 @@ "description": [], "source": { "path": "x-pack/plugins/file_upload/common/types.ts", - "lineNumber": 64 + "lineNumber": 60 } }, { @@ -1908,7 +1130,7 @@ "description": [], "source": { "path": "x-pack/plugins/file_upload/common/types.ts", - "lineNumber": 65 + "lineNumber": 61 } }, { @@ -1919,7 +1141,7 @@ "description": [], "source": { "path": "x-pack/plugins/file_upload/common/types.ts", - "lineNumber": 66 + "lineNumber": 62 } }, { @@ -1930,7 +1152,7 @@ "description": [], "source": { "path": "x-pack/plugins/file_upload/common/types.ts", - "lineNumber": 67 + "lineNumber": 63 }, "signature": [ "string[] | undefined" @@ -1944,7 +1166,7 @@ "description": [], "source": { "path": "x-pack/plugins/file_upload/common/types.ts", - "lineNumber": 68 + "lineNumber": 64 }, "signature": [ "string[] | undefined" @@ -1958,7 +1180,7 @@ "description": [], "source": { "path": "x-pack/plugins/file_upload/common/types.ts", - "lineNumber": 69 + "lineNumber": 65 }, "signature": [ "string | undefined" @@ -1972,7 +1194,7 @@ "description": [], "source": { "path": "x-pack/plugins/file_upload/common/types.ts", - "lineNumber": 70 + "lineNumber": 66 }, "signature": [ "string | undefined" @@ -1986,7 +1208,7 @@ "description": [], "source": { "path": "x-pack/plugins/file_upload/common/types.ts", - "lineNumber": 71 + "lineNumber": 67 }, "signature": [ "string | undefined" @@ -2000,7 +1222,7 @@ "description": [], "source": { "path": "x-pack/plugins/file_upload/common/types.ts", - "lineNumber": 72 + "lineNumber": 68 }, "signature": [ "string[] | undefined" @@ -2014,7 +1236,7 @@ "description": [], "source": { "path": "x-pack/plugins/file_upload/common/types.ts", - "lineNumber": 73 + "lineNumber": 69 }, "signature": [ "string[] | undefined" @@ -2028,7 +1250,7 @@ "description": [], "source": { "path": "x-pack/plugins/file_upload/common/types.ts", - "lineNumber": 74 + "lineNumber": 70 }, "signature": [ "string | undefined" @@ -2042,7 +1264,7 @@ "description": [], "source": { "path": "x-pack/plugins/file_upload/common/types.ts", - "lineNumber": 75 + "lineNumber": 71 }, "signature": [ "boolean | undefined" @@ -2051,7 +1273,7 @@ ], "source": { "path": "x-pack/plugins/file_upload/common/types.ts", - "lineNumber": 30 + "lineNumber": 26 }, "initialIsOpen": false }, @@ -2070,13 +1292,13 @@ "description": [], "source": { "path": "x-pack/plugins/file_upload/common/types.ts", - "lineNumber": 12 + "lineNumber": 93 } } ], "source": { "path": "x-pack/plugins/file_upload/common/types.ts", - "lineNumber": 11 + "lineNumber": 92 }, "initialIsOpen": false }, @@ -2095,7 +1317,7 @@ "description": [], "source": { "path": "x-pack/plugins/file_upload/common/types.ts", - "lineNumber": 94 + "lineNumber": 112 } }, { @@ -2106,7 +1328,7 @@ "description": [], "source": { "path": "x-pack/plugins/file_upload/common/types.ts", - "lineNumber": 95 + "lineNumber": 113 } }, { @@ -2117,7 +1339,7 @@ "description": [], "source": { "path": "x-pack/plugins/file_upload/common/types.ts", - "lineNumber": 96 + "lineNumber": 114 }, "signature": [ { @@ -2132,7 +1354,7 @@ ], "source": { "path": "x-pack/plugins/file_upload/common/types.ts", - "lineNumber": 93 + "lineNumber": 111 }, "initialIsOpen": false }, @@ -2151,7 +1373,7 @@ "description": [], "source": { "path": "x-pack/plugins/file_upload/common/types.ts", - "lineNumber": 81 + "lineNumber": 99 } }, { @@ -2162,7 +1384,7 @@ "description": [], "source": { "path": "x-pack/plugins/file_upload/common/types.ts", - "lineNumber": 82 + "lineNumber": 100 } }, { @@ -2173,7 +1395,7 @@ "description": [], "source": { "path": "x-pack/plugins/file_upload/common/types.ts", - "lineNumber": 83 + "lineNumber": 101 }, "signature": [ "string | undefined" @@ -2187,7 +1409,7 @@ "description": [], "source": { "path": "x-pack/plugins/file_upload/common/types.ts", - "lineNumber": 84 + "lineNumber": 102 }, "signature": [ "string | undefined" @@ -2201,7 +1423,7 @@ "description": [], "source": { "path": "x-pack/plugins/file_upload/common/types.ts", - "lineNumber": 85 + "lineNumber": 103 } }, { @@ -2212,7 +1434,7 @@ "description": [], "source": { "path": "x-pack/plugins/file_upload/common/types.ts", - "lineNumber": 86 + "lineNumber": 104 }, "signature": [ { @@ -2233,7 +1455,7 @@ "description": [], "source": { "path": "x-pack/plugins/file_upload/common/types.ts", - "lineNumber": 87 + "lineNumber": 105 }, "signature": [ "{ error: ", @@ -2249,7 +1471,7 @@ "description": [], "source": { "path": "x-pack/plugins/file_upload/common/types.ts", - "lineNumber": 90 + "lineNumber": 108 }, "signature": [ "boolean | undefined" @@ -2258,7 +1480,7 @@ ], "source": { "path": "x-pack/plugins/file_upload/common/types.ts", - "lineNumber": 80 + "lineNumber": 98 }, "initialIsOpen": false }, @@ -2277,7 +1499,7 @@ "description": [], "source": { "path": "x-pack/plugins/file_upload/common/types.ts", - "lineNumber": 127 + "lineNumber": 145 } }, { @@ -2288,7 +1510,7 @@ "description": [], "source": { "path": "x-pack/plugins/file_upload/common/types.ts", - "lineNumber": 128 + "lineNumber": 146 }, "signature": [ "any[]" @@ -2297,7 +1519,7 @@ ], "source": { "path": "x-pack/plugins/file_upload/common/types.ts", - "lineNumber": 126 + "lineNumber": 144 }, "initialIsOpen": false }, @@ -2316,7 +1538,7 @@ "description": [], "source": { "path": "x-pack/plugins/file_upload/common/types.ts", - "lineNumber": 122 + "lineNumber": 140 } }, { @@ -2327,7 +1549,7 @@ "description": [], "source": { "path": "x-pack/plugins/file_upload/common/types.ts", - "lineNumber": 123 + "lineNumber": 141 }, "signature": [ { @@ -2342,7 +1564,7 @@ ], "source": { "path": "x-pack/plugins/file_upload/common/types.ts", - "lineNumber": 121 + "lineNumber": 139 }, "initialIsOpen": false }, @@ -2361,7 +1583,7 @@ "description": [], "source": { "path": "x-pack/plugins/file_upload/common/types.ts", - "lineNumber": 16 + "lineNumber": 12 }, "signature": [ "any" @@ -2370,7 +1592,7 @@ ], "source": { "path": "x-pack/plugins/file_upload/common/types.ts", - "lineNumber": 15 + "lineNumber": 11 }, "initialIsOpen": false }, @@ -2389,7 +1611,7 @@ "description": [], "source": { "path": "x-pack/plugins/file_upload/common/types.ts", - "lineNumber": 113 + "lineNumber": 131 }, "signature": [ "{ created_by: string; } | undefined" @@ -2403,7 +1625,7 @@ "description": [], "source": { "path": "x-pack/plugins/file_upload/common/types.ts", - "lineNumber": 116 + "lineNumber": 134 }, "signature": [ "{ [key: string]: any; }" @@ -2412,7 +1634,7 @@ ], "source": { "path": "x-pack/plugins/file_upload/common/types.ts", - "lineNumber": 112 + "lineNumber": 130 }, "initialIsOpen": false }, @@ -2431,7 +1653,7 @@ "description": [], "source": { "path": "x-pack/plugins/file_upload/common/types.ts", - "lineNumber": 106 + "lineNumber": 124 }, "signature": [ "string | undefined" @@ -2445,7 +1667,7 @@ "description": [], "source": { "path": "x-pack/plugins/file_upload/common/types.ts", - "lineNumber": 107 + "lineNumber": 125 } }, { @@ -2456,7 +1678,7 @@ "description": [], "source": { "path": "x-pack/plugins/file_upload/common/types.ts", - "lineNumber": 108 + "lineNumber": 126 }, "signature": [ "any[]" @@ -2470,7 +1692,7 @@ "description": [], "source": { "path": "x-pack/plugins/file_upload/common/types.ts", - "lineNumber": 109 + "lineNumber": 127 }, "signature": [ "any" @@ -2479,7 +1701,7 @@ ], "source": { "path": "x-pack/plugins/file_upload/common/types.ts", - "lineNumber": 105 + "lineNumber": 123 }, "initialIsOpen": false } @@ -2524,7 +1746,7 @@ "description": [], "source": { "path": "x-pack/plugins/file_upload/common/types.ts", - "lineNumber": 19 + "lineNumber": 15 }, "signature": [ "InputOverrides & { column_names: string[]; has_header_row: boolean; should_trim_fields: boolean; }" @@ -2539,7 +1761,7 @@ "description": [], "source": { "path": "x-pack/plugins/file_upload/common/types.ts", - "lineNumber": 103 + "lineNumber": 121 }, "signature": [ "string | object | ", @@ -2564,7 +1786,7 @@ "lineNumber": 19 }, "signature": [ - "\"ml-file-data-visualizer\"" + "\"file-data-visualizer\"" ], "initialIsOpen": false }, @@ -2576,7 +1798,7 @@ "description": [], "source": { "path": "x-pack/plugins/file_upload/common/types.ts", - "lineNumber": 78 + "lineNumber": 96 }, "signature": [ "any[]" 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..e525daefe2f41 100644 --- a/api_docs/fleet.json +++ b/api_docs/fleet.json @@ -228,7 +228,7 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/package_policy.ts", - "lineNumber": 50 + "lineNumber": 51 } }, { @@ -239,7 +239,7 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/package_policy.ts", - "lineNumber": 51 + "lineNumber": 52 }, "signature": [ "string | undefined" @@ -253,7 +253,7 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/package_policy.ts", - "lineNumber": 52 + "lineNumber": 53 } }, { @@ -264,7 +264,7 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/package_policy.ts", - "lineNumber": 53 + "lineNumber": 54 } }, { @@ -275,7 +275,7 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/package_policy.ts", - "lineNumber": 54 + "lineNumber": 55 } }, { @@ -286,7 +286,7 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/package_policy.ts", - "lineNumber": 55 + "lineNumber": 56 } }, { @@ -297,7 +297,7 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/package_policy.ts", - "lineNumber": 56 + "lineNumber": 57 }, "signature": [ { @@ -318,7 +318,7 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/package_policy.ts", - "lineNumber": 57 + "lineNumber": 58 }, "signature": [ { @@ -334,7 +334,7 @@ ], "source": { "path": "x-pack/plugins/fleet/common/types/models/package_policy.ts", - "lineNumber": 49 + "lineNumber": 50 }, "initialIsOpen": false }, @@ -1500,7 +1500,7 @@ "children": [], "source": { "path": "x-pack/plugins/fleet/public/plugin.ts", - "lineNumber": 50 + "lineNumber": 51 }, "lifecycle": "setup", "initialIsOpen": true @@ -1522,7 +1522,7 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/public/plugin.ts", - "lineNumber": 56 + "lineNumber": 57 }, "signature": [ { @@ -1542,7 +1542,7 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/public/plugin.ts", - "lineNumber": 57 + "lineNumber": 58 }, "signature": [ "() => Promise" @@ -1551,7 +1551,7 @@ ], "source": { "path": "x-pack/plugins/fleet/public/plugin.ts", - "lineNumber": 55 + "lineNumber": 56 }, "lifecycle": "start", "initialIsOpen": true @@ -2373,7 +2373,7 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/server/plugin.ts", - "lineNumber": 96 + "lineNumber": 92 }, "signature": [ { @@ -2393,7 +2393,7 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/server/plugin.ts", - "lineNumber": 97 + "lineNumber": 93 }, "signature": [ { @@ -2414,7 +2414,7 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/server/plugin.ts", - "lineNumber": 98 + "lineNumber": 94 }, "signature": [ { @@ -2435,7 +2435,7 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/server/plugin.ts", - "lineNumber": 99 + "lineNumber": 95 }, "signature": [ { @@ -2455,7 +2455,7 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/server/plugin.ts", - "lineNumber": 100 + "lineNumber": 96 }, "signature": [ { @@ -2476,18 +2476,23 @@ "description": [], "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" + { + "pluginId": "usageCollection", + "scope": "server", + "docId": "kibUsageCollectionPluginApi", + "section": "def-server.UsageCollectionSetup", + "text": "UsageCollectionSetup" + }, + " | undefined" ] } ], "source": { "path": "x-pack/plugins/fleet/server/plugin.ts", - "lineNumber": 95 + "lineNumber": 91 }, "initialIsOpen": false }, @@ -2589,7 +2594,7 @@ ], "source": { "path": "x-pack/plugins/fleet/server/plugin.ts", - "lineNumber": 141 + "lineNumber": 137 }, "signature": [ "[\"packagePolicyCreate\", (newPackagePolicy: ", @@ -2643,7 +2648,7 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/server/index.ts", - "lineNumber": 83 + "lineNumber": 66 }, "signature": [ "any" @@ -2658,7 +2663,7 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/server/services/package_policy.ts", - "lineNumber": 592 + "lineNumber": 648 }, "signature": [ "PackagePolicyService" @@ -2691,7 +2696,7 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/server/plugin.ts", - "lineNumber": 126 + "lineNumber": 122 }, "signature": [ "void" @@ -2718,7 +2723,7 @@ ], "source": { "path": "x-pack/plugins/fleet/server/plugin.ts", - "lineNumber": 170 + "lineNumber": 166 }, "signature": [ "() => Promise" @@ -2732,7 +2737,7 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/server/plugin.ts", - "lineNumber": 171 + "lineNumber": 167 }, "signature": [ { @@ -2752,7 +2757,7 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/server/plugin.ts", - "lineNumber": 172 + "lineNumber": 168 }, "signature": [ { @@ -2772,7 +2777,7 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/server/plugin.ts", - "lineNumber": 173 + "lineNumber": 169 }, "signature": [ { @@ -2794,7 +2799,7 @@ ], "source": { "path": "x-pack/plugins/fleet/server/plugin.ts", - "lineNumber": 177 + "lineNumber": 173 }, "signature": [ "PackagePolicyService" @@ -2808,7 +2813,7 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/server/plugin.ts", - "lineNumber": 178 + "lineNumber": 174 }, "signature": [ { @@ -2830,7 +2835,7 @@ ], "source": { "path": "x-pack/plugins/fleet/server/plugin.ts", - "lineNumber": 183 + "lineNumber": 179 }, "signature": [ "(...args: ", @@ -2854,7 +2859,7 @@ ], "source": { "path": "x-pack/plugins/fleet/server/plugin.ts", - "lineNumber": 189 + "lineNumber": 185 }, "signature": [ "(packageName: string) => ", @@ -2864,7 +2869,7 @@ ], "source": { "path": "x-pack/plugins/fleet/server/plugin.ts", - "lineNumber": 164 + "lineNumber": 160 }, "lifecycle": "start", "initialIsOpen": true @@ -3112,7 +3117,7 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/index.ts", - "lineNumber": 42 + "lineNumber": 44 }, "signature": [ "(o: T) => [keyof T, T[keyof T]][]" @@ -3596,30 +3601,9 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/agent.ts", - "lineNumber": 151 + "lineNumber": 119 } }, - { - "tags": [], - "id": "def-common.Agent.current_error_events", - "type": "Array", - "label": "current_error_events", - "description": [], - "source": { - "path": "x-pack/plugins/fleet/common/types/models/agent.ts", - "lineNumber": 152 - }, - "signature": [ - { - "pluginId": "fleet", - "scope": "common", - "docId": "kibFleetPluginApi", - "section": "def-common.AgentEvent", - "text": "AgentEvent" - }, - "[]" - ] - }, { "tags": [], "id": "def-common.Agent.access_api_key", @@ -3628,7 +3612,7 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/agent.ts", - "lineNumber": 153 + "lineNumber": 120 }, "signature": [ "string | undefined" @@ -3642,7 +3626,7 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/agent.ts", - "lineNumber": 154 + "lineNumber": 121 }, "signature": [ "string | undefined" @@ -3656,7 +3640,7 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/agent.ts", - "lineNumber": 155 + "lineNumber": 122 }, "signature": [ "string[]" @@ -3665,7 +3649,7 @@ ], "source": { "path": "x-pack/plugins/fleet/common/types/models/agent.ts", - "lineNumber": 150 + "lineNumber": 118 }, "initialIsOpen": false }, @@ -3795,48 +3779,6 @@ }, "initialIsOpen": false }, - { - "id": "def-common.AgentEvent", - "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 - } - } - ], - "source": { - "path": "x-pack/plugins/fleet/common/types/models/agent.ts", - "lineNumber": 122 - }, - "initialIsOpen": false - }, { "id": "def-common.AgentMetadata", "type": "Interface", @@ -3852,7 +3794,7 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/agent.ts", - "lineNumber": 129 + "lineNumber": 97 }, "signature": [ "any" @@ -3861,7 +3803,7 @@ ], "source": { "path": "x-pack/plugins/fleet/common/types/models/agent.ts", - "lineNumber": 128 + "lineNumber": 96 }, "initialIsOpen": false }, @@ -4142,20 +4084,6 @@ "description": [], "tags": [], "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": [], "id": "def-common.AgentSOAttributes.packages", @@ -4164,7 +4092,7 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/agent.ts", - "lineNumber": 160 + "lineNumber": 126 }, "signature": [ "string[] | undefined" @@ -4173,7 +4101,7 @@ ], "source": { "path": "x-pack/plugins/fleet/common/types/models/agent.ts", - "lineNumber": 158 + "lineNumber": 125 }, "initialIsOpen": false }, @@ -4192,7 +4120,7 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 217 + "lineNumber": 222 } }, { @@ -4203,7 +4131,7 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 218 + "lineNumber": 223 }, "signature": [ "string | undefined" @@ -4217,7 +4145,7 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 219 + "lineNumber": 224 }, "signature": [ { @@ -4237,7 +4165,7 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 220 + "lineNumber": 225 }, "signature": [ { @@ -4257,13 +4185,13 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 221 + "lineNumber": 226 } } ], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 216 + "lineNumber": 221 }, "initialIsOpen": false }, @@ -4290,45 +4218,31 @@ }, { "tags": [], - "id": "def-common.BaseSettings.fleet_server_hosts", - "type": "Array", - "label": "fleet_server_hosts", + "id": "def-common.BaseSettings.has_seen_fleet_migration_notice", + "type": "CompoundType", + "label": "has_seen_fleet_migration_notice", "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/settings.ts", "lineNumber": 12 }, "signature": [ - "string[]" + "boolean | undefined" ] }, { "tags": [], - "id": "def-common.BaseSettings.kibana_urls", + "id": "def-common.BaseSettings.fleet_server_hosts", "type": "Array", - "label": "kibana_urls", + "label": "fleet_server_hosts", "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/settings.ts", - "lineNumber": 14 + "lineNumber": 13 }, "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 - }, - "signature": [ - "string | undefined" - ] } ], "source": { @@ -4352,7 +4266,7 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts", - "lineNumber": 91 + "lineNumber": 94 } }, { @@ -4363,7 +4277,7 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts", - "lineNumber": 92 + "lineNumber": 95 } }, { @@ -4374,7 +4288,7 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts", - "lineNumber": 93 + "lineNumber": 96 }, "signature": [ { @@ -4389,7 +4303,7 @@ ], "source": { "path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts", - "lineNumber": 90 + "lineNumber": 93 }, "initialIsOpen": false }, @@ -4408,7 +4322,7 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts", - "lineNumber": 101 + "lineNumber": 104 }, "signature": [ "{ packages: string[]; }" @@ -4417,7 +4331,7 @@ ], "source": { "path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts", - "lineNumber": 100 + "lineNumber": 103 }, "initialIsOpen": false }, @@ -4436,7 +4350,7 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts", - "lineNumber": 97 + "lineNumber": 100 }, "signature": [ "(", @@ -4461,7 +4375,7 @@ ], "source": { "path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts", - "lineNumber": 96 + "lineNumber": 99 }, "initialIsOpen": false }, @@ -4480,7 +4394,7 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 210 + "lineNumber": 215 } }, { @@ -4491,7 +4405,7 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 211 + "lineNumber": 216 } }, { @@ -4502,13 +4416,13 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 212 + "lineNumber": 217 } } ], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 209 + "lineNumber": 214 }, "initialIsOpen": false }, @@ -4898,6 +4812,54 @@ }, "initialIsOpen": false }, + { + "id": "def-common.DefaultPackagesInstallationError", + "type": "Interface", + "label": "DefaultPackagesInstallationError", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.DefaultPackagesInstallationError.installType", + "type": "CompoundType", + "label": "installType", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/epm.ts", + "lineNumber": 34 + }, + "signature": [ + { + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.InstallType", + "text": "InstallType" + } + ] + }, + { + "tags": [], + "id": "def-common.DefaultPackagesInstallationError.error", + "type": "Object", + "label": "error", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/epm.ts", + "lineNumber": 35 + }, + "signature": [ + "Error" + ] + } + ], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/epm.ts", + "lineNumber": 33 + }, + "initialIsOpen": false + }, { "id": "def-common.DeleteAgentPolicyRequest", "type": "Interface", @@ -4977,7 +4939,7 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts", - "lineNumber": 205 + "lineNumber": 135 }, "signature": [ "{ agentId: string; }" @@ -4986,7 +4948,7 @@ ], "source": { "path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts", - "lineNumber": 204 + "lineNumber": 134 }, "initialIsOpen": false }, @@ -5086,7 +5048,7 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts", - "lineNumber": 111 + "lineNumber": 114 }, "signature": [ "{ pkgkey: string; }" @@ -5095,7 +5057,7 @@ ], "source": { "path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts", - "lineNumber": 110 + "lineNumber": 113 }, "initialIsOpen": false }, @@ -5114,7 +5076,7 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts", - "lineNumber": 117 + "lineNumber": 120 }, "signature": [ { @@ -5130,7 +5092,7 @@ ], "source": { "path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts", - "lineNumber": 116 + "lineNumber": 119 }, "initialIsOpen": false }, @@ -5246,7 +5208,7 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 316 + "lineNumber": 321 } }, { @@ -5257,7 +5219,7 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 317 + "lineNumber": 322 } }, { @@ -5268,7 +5230,7 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 318 + "lineNumber": 323 }, "signature": [ { @@ -5288,7 +5250,7 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 319 + "lineNumber": 324 }, "signature": [ "boolean | undefined" @@ -5297,7 +5259,7 @@ ], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 315 + "lineNumber": 320 }, "initialIsOpen": false }, @@ -5316,7 +5278,7 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/index.ts", - "lineNumber": 12 + "lineNumber": 13 } }, { @@ -5327,7 +5289,7 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/index.ts", - "lineNumber": 13 + "lineNumber": 14 }, "signature": [ "string | undefined" @@ -5341,7 +5303,7 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/index.ts", - "lineNumber": 14 + "lineNumber": 15 }, "signature": [ "string | undefined" @@ -5355,16 +5317,59 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/index.ts", - "lineNumber": 15 + "lineNumber": 16 + }, + "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; }" + ] + }, + { + "tags": [], + "id": "def-common.FleetConfigType.agentPolicies", + "type": "Array", + "label": "agentPolicies", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/index.ts", + "lineNumber": 35 + }, + "signature": [ + { + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.PreconfiguredAgentPolicy", + "text": "PreconfiguredAgentPolicy" + }, + "[] | undefined" + ] + }, + { + "tags": [], + "id": "def-common.FleetConfigType.packages", + "type": "Array", + "label": "packages", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/index.ts", + "lineNumber": 36 }, "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": 11 + "lineNumber": 12 }, "initialIsOpen": false }, @@ -5387,7 +5392,7 @@ ], "source": { "path": "x-pack/plugins/fleet/common/types/models/agent.ts", - "lineNumber": 172 + "lineNumber": 138 }, "signature": [ "number | undefined" @@ -5403,7 +5408,7 @@ ], "source": { "path": "x-pack/plugins/fleet/common/types/models/agent.ts", - "lineNumber": 176 + "lineNumber": 142 }, "signature": [ "string | undefined" @@ -5419,7 +5424,7 @@ ], "source": { "path": "x-pack/plugins/fleet/common/types/models/agent.ts", - "lineNumber": 180 + "lineNumber": 146 }, "signature": [ { @@ -5441,7 +5446,7 @@ ], "source": { "path": "x-pack/plugins/fleet/common/types/models/agent.ts", - "lineNumber": 184 + "lineNumber": 150 } }, { @@ -5454,7 +5459,7 @@ ], "source": { "path": "x-pack/plugins/fleet/common/types/models/agent.ts", - "lineNumber": 188 + "lineNumber": 154 } }, { @@ -5467,7 +5472,7 @@ ], "source": { "path": "x-pack/plugins/fleet/common/types/models/agent.ts", - "lineNumber": 192 + "lineNumber": 158 }, "signature": [ "string | undefined" @@ -5483,7 +5488,7 @@ ], "source": { "path": "x-pack/plugins/fleet/common/types/models/agent.ts", - "lineNumber": 196 + "lineNumber": 162 }, "signature": [ "string | undefined" @@ -5499,7 +5504,7 @@ ], "source": { "path": "x-pack/plugins/fleet/common/types/models/agent.ts", - "lineNumber": 200 + "lineNumber": 166 }, "signature": [ "string | null | undefined" @@ -5515,7 +5520,7 @@ ], "source": { "path": "x-pack/plugins/fleet/common/types/models/agent.ts", - "lineNumber": 204 + "lineNumber": 170 }, "signature": [ "string | null | undefined" @@ -5531,7 +5536,7 @@ ], "source": { "path": "x-pack/plugins/fleet/common/types/models/agent.ts", - "lineNumber": 208 + "lineNumber": 174 }, "signature": [ "string | undefined" @@ -5545,7 +5550,7 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/agent.ts", - "lineNumber": 209 + "lineNumber": 175 }, "signature": [ { @@ -5568,7 +5573,7 @@ ], "source": { "path": "x-pack/plugins/fleet/common/types/models/agent.ts", - "lineNumber": 213 + "lineNumber": 179 }, "signature": [ { @@ -5590,7 +5595,7 @@ ], "source": { "path": "x-pack/plugins/fleet/common/types/models/agent.ts", - "lineNumber": 217 + "lineNumber": 183 }, "signature": [ { @@ -5612,7 +5617,7 @@ ], "source": { "path": "x-pack/plugins/fleet/common/types/models/agent.ts", - "lineNumber": 221 + "lineNumber": 187 }, "signature": [ "string | undefined" @@ -5628,7 +5633,7 @@ ], "source": { "path": "x-pack/plugins/fleet/common/types/models/agent.ts", - "lineNumber": 225 + "lineNumber": 191 }, "signature": [ "number | null | undefined" @@ -5644,7 +5649,7 @@ ], "source": { "path": "x-pack/plugins/fleet/common/types/models/agent.ts", - "lineNumber": 229 + "lineNumber": 195 }, "signature": [ "number | undefined" @@ -5660,7 +5665,7 @@ ], "source": { "path": "x-pack/plugins/fleet/common/types/models/agent.ts", - "lineNumber": 233 + "lineNumber": 199 }, "signature": [ "string | undefined" @@ -5676,7 +5681,7 @@ ], "source": { "path": "x-pack/plugins/fleet/common/types/models/agent.ts", - "lineNumber": 237 + "lineNumber": 203 }, "signature": [ "string | undefined" @@ -5692,7 +5697,7 @@ ], "source": { "path": "x-pack/plugins/fleet/common/types/models/agent.ts", - "lineNumber": 241 + "lineNumber": 207 }, "signature": [ "\"online\" | \"error\" | \"updating\" | \"degraded\" | undefined" @@ -5708,7 +5713,7 @@ ], "source": { "path": "x-pack/plugins/fleet/common/types/models/agent.ts", - "lineNumber": 245 + "lineNumber": 211 }, "signature": [ "string | undefined" @@ -5724,7 +5729,7 @@ ], "source": { "path": "x-pack/plugins/fleet/common/types/models/agent.ts", - "lineNumber": 249 + "lineNumber": 215 }, "signature": [ "string | undefined" @@ -5740,7 +5745,7 @@ ], "source": { "path": "x-pack/plugins/fleet/common/types/models/agent.ts", - "lineNumber": 253 + "lineNumber": 219 }, "signature": [ "string | undefined" @@ -5756,7 +5761,7 @@ ], "source": { "path": "x-pack/plugins/fleet/common/types/models/agent.ts", - "lineNumber": 257 + "lineNumber": 223 }, "signature": [ "string[] | undefined" @@ -5772,7 +5777,7 @@ ], "source": { "path": "x-pack/plugins/fleet/common/types/models/agent.ts", - "lineNumber": 261 + "lineNumber": 227 }, "signature": [ "number | undefined" @@ -5781,7 +5786,7 @@ ], "source": { "path": "x-pack/plugins/fleet/common/types/models/agent.ts", - "lineNumber": 168 + "lineNumber": 134 }, "initialIsOpen": false }, @@ -5804,7 +5809,7 @@ ], "source": { "path": "x-pack/plugins/fleet/common/types/models/agent.ts", - "lineNumber": 285 + "lineNumber": 251 }, "signature": [ "string | undefined" @@ -5820,7 +5825,7 @@ ], "source": { "path": "x-pack/plugins/fleet/common/types/models/agent.ts", - "lineNumber": 289 + "lineNumber": 255 }, "signature": [ "number | undefined" @@ -5836,7 +5841,7 @@ ], "source": { "path": "x-pack/plugins/fleet/common/types/models/agent.ts", - "lineNumber": 293 + "lineNumber": 259 }, "signature": [ "string | undefined" @@ -5852,7 +5857,7 @@ ], "source": { "path": "x-pack/plugins/fleet/common/types/models/agent.ts", - "lineNumber": 297 + "lineNumber": 263 }, "signature": [ "string | undefined" @@ -5868,7 +5873,7 @@ ], "source": { "path": "x-pack/plugins/fleet/common/types/models/agent.ts", - "lineNumber": 301 + "lineNumber": 267 }, "signature": [ "string | undefined" @@ -5884,7 +5889,7 @@ ], "source": { "path": "x-pack/plugins/fleet/common/types/models/agent.ts", - "lineNumber": 305 + "lineNumber": 271 }, "signature": [ "string | undefined" @@ -5900,7 +5905,7 @@ ], "source": { "path": "x-pack/plugins/fleet/common/types/models/agent.ts", - "lineNumber": 309 + "lineNumber": 275 }, "signature": [ "string | undefined" @@ -5916,7 +5921,7 @@ ], "source": { "path": "x-pack/plugins/fleet/common/types/models/agent.ts", - "lineNumber": 313 + "lineNumber": 279 }, "signature": [ "string[] | undefined" @@ -5932,7 +5937,7 @@ ], "source": { "path": "x-pack/plugins/fleet/common/types/models/agent.ts", - "lineNumber": 317 + "lineNumber": 283 }, "signature": [ "{ [k: string]: unknown; } | undefined" @@ -5946,7 +5951,7 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/agent.ts", - "lineNumber": 320 + "lineNumber": 286 }, "signature": [ "any" @@ -5955,7 +5960,7 @@ ], "source": { "path": "x-pack/plugins/fleet/common/types/models/agent.ts", - "lineNumber": 281 + "lineNumber": 247 }, "initialIsOpen": false }, @@ -5978,7 +5983,7 @@ ], "source": { "path": "x-pack/plugins/fleet/common/types/models/agent.ts", - "lineNumber": 270 + "lineNumber": 236 } }, { @@ -5991,7 +5996,7 @@ ], "source": { "path": "x-pack/plugins/fleet/common/types/models/agent.ts", - "lineNumber": 274 + "lineNumber": 240 } }, { @@ -6002,7 +6007,7 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/agent.ts", - "lineNumber": 275 + "lineNumber": 241 }, "signature": [ "any" @@ -6011,7 +6016,7 @@ ], "source": { "path": "x-pack/plugins/fleet/common/types/models/agent.ts", - "lineNumber": 266 + "lineNumber": 232 }, "initialIsOpen": false }, @@ -6659,6 +6664,42 @@ }, "initialIsOpen": false }, + { + "id": "def-common.GenerateServiceTokenResponse", + "type": "Interface", + "label": "GenerateServiceTokenResponse", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.GenerateServiceTokenResponse.name", + "type": "string", + "label": "name", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/rest_spec/app.ts", + "lineNumber": 14 + } + }, + { + "tags": [], + "id": "def-common.GenerateServiceTokenResponse.value", + "type": "string", + "label": "value", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/rest_spec/app.ts", + "lineNumber": 15 + } + } + ], + "source": { + "path": "x-pack/plugins/fleet/common/types/rest_spec/app.ts", + "lineNumber": 13 + }, + "initialIsOpen": false + }, { "id": "def-common.GetAgentPoliciesRequest", "type": "Interface", @@ -6777,7 +6818,7 @@ "description": [], "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; }" @@ -6786,7 +6827,7 @@ ], "source": { "path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts", - "lineNumber": 18 + "lineNumber": 10 }, "initialIsOpen": false }, @@ -6805,7 +6846,7 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts", - "lineNumber": 29 + "lineNumber": 21 }, "signature": [ { @@ -6826,7 +6867,7 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts", - "lineNumber": 30 + "lineNumber": 22 } }, { @@ -6837,7 +6878,7 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts", - "lineNumber": 31 + "lineNumber": 23 } }, { @@ -6848,7 +6889,7 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts", - "lineNumber": 32 + "lineNumber": 24 } }, { @@ -6859,13 +6900,13 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts", - "lineNumber": 33 + "lineNumber": 25 } } ], "source": { "path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts", - "lineNumber": 28 + "lineNumber": 20 }, "initialIsOpen": false }, @@ -6884,7 +6925,7 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts", - "lineNumber": 220 + "lineNumber": 150 }, "signature": [ "{ kuery?: string | undefined; policyId?: string | undefined; }" @@ -6893,7 +6934,7 @@ ], "source": { "path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts", - "lineNumber": 219 + "lineNumber": 149 }, "initialIsOpen": false }, @@ -6912,7 +6953,7 @@ "description": [], "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; }" @@ -6921,7 +6962,7 @@ ], "source": { "path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts", - "lineNumber": 226 + "lineNumber": 156 }, "initialIsOpen": false }, @@ -6940,7 +6981,7 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts", - "lineNumber": 18 + "lineNumber": 19 }, "signature": [ "{ experimental?: boolean | undefined; }" @@ -6949,7 +6990,7 @@ ], "source": { "path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts", - "lineNumber": 17 + "lineNumber": 18 }, "initialIsOpen": false }, @@ -6968,7 +7009,7 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts", - "lineNumber": 24 + "lineNumber": 25 }, "signature": [ { @@ -6983,7 +7024,7 @@ ], "source": { "path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts", - "lineNumber": 23 + "lineNumber": 24 }, "initialIsOpen": false }, @@ -7133,7 +7174,7 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts", - "lineNumber": 43 + "lineNumber": 44 }, "signature": [ "{ pkgkey: string; filePath: string; }" @@ -7142,7 +7183,7 @@ ], "source": { "path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts", - "lineNumber": 42 + "lineNumber": 43 }, "initialIsOpen": false }, @@ -7175,7 +7216,7 @@ "lineNumber": 14 }, "signature": [ - "(\"tls_required\" | \"api_keys\" | \"fleet_admin_user\" | \"encrypted_saved_object_encryption_key_required\")[]" + "(\"fleet_server\" | \"tls_required\" | \"api_keys\" | \"fleet_admin_user\" | \"encrypted_saved_object_encryption_key_required\")[]" ] } ], @@ -7262,7 +7303,7 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts", - "lineNumber": 50 + "lineNumber": 51 }, "signature": [ "{ pkgkey: string; }" @@ -7271,7 +7312,7 @@ ], "source": { "path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts", - "lineNumber": 49 + "lineNumber": 50 }, "initialIsOpen": false }, @@ -7290,7 +7331,7 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts", - "lineNumber": 56 + "lineNumber": 57 }, "signature": [ { @@ -7305,7 +7346,7 @@ ], "source": { "path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts", - "lineNumber": 55 + "lineNumber": 56 }, "initialIsOpen": false }, @@ -7324,7 +7365,7 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts", - "lineNumber": 39 + "lineNumber": 40 }, "signature": [ "string[]" @@ -7333,117 +7374,7 @@ ], "source": { "path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts", - "lineNumber": 38 - }, - "initialIsOpen": false - }, - { - "id": "def-common.GetOneAgentEventsRequest", - "type": "Interface", - "label": "GetOneAgentEventsRequest", - "description": [], - "tags": [], - "children": [ - { - "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", - "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": [], - "source": { - "path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts", - "lineNumber": 198 - }, - "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 - } - } - ], - "source": { - "path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts", - "lineNumber": 197 + "lineNumber": 39 }, "initialIsOpen": false }, @@ -7524,7 +7455,7 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts", - "lineNumber": 37 + "lineNumber": 29 }, "signature": [ "{ agentId: string; }" @@ -7533,7 +7464,7 @@ ], "source": { "path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts", - "lineNumber": 36 + "lineNumber": 28 }, "initialIsOpen": false }, @@ -7552,7 +7483,7 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts", - "lineNumber": 43 + "lineNumber": 35 }, "signature": [ { @@ -7567,7 +7498,7 @@ ], "source": { "path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts", - "lineNumber": 42 + "lineNumber": 34 }, "initialIsOpen": false }, @@ -7936,7 +7867,7 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts", - "lineNumber": 28 + "lineNumber": 29 }, "signature": [ "{ category?: string | undefined; experimental?: boolean | undefined; }" @@ -7945,7 +7876,7 @@ ], "source": { "path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts", - "lineNumber": 27 + "lineNumber": 28 }, "initialIsOpen": false }, @@ -7964,7 +7895,7 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts", - "lineNumber": 35 + "lineNumber": 36 }, "signature": [ { @@ -7988,7 +7919,7 @@ ], "source": { "path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts", - "lineNumber": 34 + "lineNumber": 35 }, "initialIsOpen": false }, @@ -8041,7 +7972,7 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts", - "lineNumber": 60 + "lineNumber": 61 }, "signature": [ "{ pkgname: string; }" @@ -8050,7 +7981,7 @@ ], "source": { "path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts", - "lineNumber": 59 + "lineNumber": 60 }, "initialIsOpen": false }, @@ -8069,7 +8000,7 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts", - "lineNumber": 66 + "lineNumber": 67 }, "signature": [ { @@ -8084,7 +8015,7 @@ ], "source": { "path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts", - "lineNumber": 65 + "lineNumber": 66 }, "initialIsOpen": false }, @@ -8103,7 +8034,7 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts", - "lineNumber": 80 + "lineNumber": 81 } }, { @@ -8114,7 +8045,7 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts", - "lineNumber": 81 + "lineNumber": 82 } }, { @@ -8125,7 +8056,7 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts", - "lineNumber": 82 + "lineNumber": 83 }, "signature": [ "string | Error" @@ -8134,7 +8065,7 @@ ], "source": { "path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts", - "lineNumber": 79 + "lineNumber": 80 }, "initialIsOpen": false }, @@ -8153,7 +8084,7 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 387 + "lineNumber": 392 } }, { @@ -8164,7 +8095,7 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 388 + "lineNumber": 393 }, "signature": [ "string[]" @@ -8178,7 +8109,7 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 389 + "lineNumber": 394 }, "signature": [ "{ settings: any; mappings: any; }" @@ -8192,7 +8123,7 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 393 + "lineNumber": 398 }, "signature": [ "{ hidden?: boolean | undefined; }" @@ -8206,7 +8137,7 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 394 + "lineNumber": 399 }, "signature": [ "string[]" @@ -8220,7 +8151,7 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 395 + "lineNumber": 400 }, "signature": [ "object" @@ -8229,7 +8160,7 @@ ], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 386 + "lineNumber": 391 }, "initialIsOpen": false }, @@ -8248,7 +8179,7 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 380 + "lineNumber": 385 }, "signature": [ "any" @@ -8257,7 +8188,7 @@ ], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 379 + "lineNumber": 384 }, "initialIsOpen": false }, @@ -8287,7 +8218,7 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 335 + "lineNumber": 340 }, "signature": [ { @@ -8308,7 +8239,7 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 336 + "lineNumber": 341 }, "signature": [ { @@ -8329,7 +8260,7 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 337 + "lineNumber": 342 }, "signature": [ { @@ -8350,7 +8281,7 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 338 + "lineNumber": 343 }, "signature": [ "Record" @@ -8364,7 +8295,7 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 339 + "lineNumber": 344 } }, { @@ -8375,7 +8306,7 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 340 + "lineNumber": 345 } }, { @@ -8386,7 +8317,7 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 341 + "lineNumber": 346 }, "signature": [ { @@ -8406,7 +8337,7 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 342 + "lineNumber": 347 } }, { @@ -8417,7 +8348,7 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 343 + "lineNumber": 348 } }, { @@ -8428,7 +8359,7 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 344 + "lineNumber": 349 }, "signature": [ { @@ -8443,7 +8374,7 @@ ], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 334 + "lineNumber": 339 }, "initialIsOpen": false }, @@ -8462,7 +8393,7 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts", - "lineNumber": 70 + "lineNumber": 71 }, "signature": [ "{ pkgkey: string; }" @@ -8471,7 +8402,7 @@ ], "source": { "path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts", - "lineNumber": 69 + "lineNumber": 70 }, "initialIsOpen": false }, @@ -8490,7 +8421,7 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts", - "lineNumber": 76 + "lineNumber": 77 }, "signature": [ { @@ -8506,7 +8437,7 @@ ], "source": { "path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts", - "lineNumber": 75 + "lineNumber": 76 }, "initialIsOpen": false }, @@ -8525,7 +8456,7 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts", - "lineNumber": 86 + "lineNumber": 87 }, "signature": [ { @@ -8535,7 +8466,7 @@ "section": "def-common.AssetReference", "text": "AssetReference" }, - "[]" + "[] | undefined" ] }, { @@ -8546,21 +8477,55 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts", - "lineNumber": 87 + "lineNumber": 88 }, "signature": [ - "\"installed\" | \"already_installed\"" + "\"installed\" | \"already_installed\" | undefined" ] - } - ], - "source": { - "path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts", - "lineNumber": 85 - }, - "initialIsOpen": false - }, - { - "id": "def-common.InstallScriptRequest", + }, + { + "tags": [], + "id": "def-common.InstallResult.error", + "type": "Object", + "label": "error", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts", + "lineNumber": 89 + }, + "signature": [ + "Error | undefined" + ] + }, + { + "tags": [], + "id": "def-common.InstallResult.installType", + "type": "CompoundType", + "label": "installType", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts", + "lineNumber": 90 + }, + "signature": [ + { + "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": 86 + }, + "initialIsOpen": false + }, + { + "id": "def-common.InstallScriptRequest", "type": "Interface", "label": "InstallScriptRequest", "description": [], @@ -8774,13 +8739,13 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts", - "lineNumber": 107 + "lineNumber": 110 } } ], "source": { "path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts", - "lineNumber": 106 + "lineNumber": 109 }, "initialIsOpen": false }, @@ -8846,137 +8811,6 @@ }, "initialIsOpen": false }, - { - "id": "def-common.NewAgentEvent", - "type": "Interface", - "label": "NewAgentEvent", - "description": [], - "tags": [], - "children": [ - { - "tags": [], - "id": "def-common.NewAgentEvent.type", - "type": "CompoundType", - "label": "type", - "description": [], - "source": { - "path": "x-pack/plugins/fleet/common/types/models/agent.ts", - "lineNumber": 97 - }, - "signature": [ - "\"STATE\" | \"ERROR\" | \"ACTION_RESULT\" | \"ACTION\"" - ] - }, - { - "tags": [], - "id": "def-common.NewAgentEvent.subtype", - "type": "CompoundType", - "label": "subtype", - "description": [], - "source": { - "path": "x-pack/plugins/fleet/common/types/models/agent.ts", - "lineNumber": 98 - }, - "signature": [ - "\"RUNNING\" | \"STARTING\" | \"IN_PROGRESS\" | \"CONFIG\" | \"FAILED\" | \"STOPPING\" | \"STOPPED\" | \"DEGRADED\" | \"UPDATING\" | \"DATA_DUMP\" | \"ACKNOWLEDGED\" | \"UNKNOWN\"" - ] - }, - { - "tags": [], - "id": "def-common.NewAgentEvent.timestamp", - "type": "string", - "label": "timestamp", - "description": [], - "source": { - "path": "x-pack/plugins/fleet/common/types/models/agent.ts", - "lineNumber": 113 - } - }, - { - "tags": [], - "id": "def-common.NewAgentEvent.message", - "type": "string", - "label": "message", - "description": [], - "source": { - "path": "x-pack/plugins/fleet/common/types/models/agent.ts", - "lineNumber": 114 - } - }, - { - "tags": [], - "id": "def-common.NewAgentEvent.payload", - "type": "Any", - "label": "payload", - "description": [], - "source": { - "path": "x-pack/plugins/fleet/common/types/models/agent.ts", - "lineNumber": 115 - }, - "signature": [ - "any" - ] - }, - { - "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", @@ -9078,16 +8912,16 @@ }, { "tags": [], - "id": "def-common.NewAgentPolicy.preconfiguration_id", - "type": "string", - "label": "preconfiguration_id", + "id": "def-common.NewAgentPolicy.is_preconfigured", + "type": "CompoundType", + "label": "is_preconfigured", "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts", "lineNumber": 24 }, "signature": [ - "string | undefined" + "boolean | undefined" ] } ], @@ -9182,34 +9016,6 @@ "string | undefined" ] }, - { - "tags": [], - "id": "def-common.NewOutput.fleet_enroll_username", - "type": "string", - "label": "fleet_enroll_username", - "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 - }, - "signature": [ - "string | undefined" - ] - }, { "tags": [], "id": "def-common.NewOutput.config", @@ -9218,7 +9024,7 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/output.ts", - "lineNumber": 22 + "lineNumber": 20 }, "signature": [ "Record | undefined" @@ -9232,7 +9038,7 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/output.ts", - "lineNumber": 23 + "lineNumber": 21 }, "signature": [ "string | undefined" @@ -9260,7 +9066,7 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/package_policy.ts", - "lineNumber": 50 + "lineNumber": 51 } }, { @@ -9271,7 +9077,7 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/package_policy.ts", - "lineNumber": 51 + "lineNumber": 52 }, "signature": [ "string | undefined" @@ -9285,7 +9091,7 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/package_policy.ts", - "lineNumber": 52 + "lineNumber": 53 } }, { @@ -9296,7 +9102,7 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/package_policy.ts", - "lineNumber": 53 + "lineNumber": 54 } }, { @@ -9307,7 +9113,7 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/package_policy.ts", - "lineNumber": 54 + "lineNumber": 55 } }, { @@ -9318,7 +9124,7 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/package_policy.ts", - "lineNumber": 55 + "lineNumber": 56 } }, { @@ -9329,7 +9135,7 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/package_policy.ts", - "lineNumber": 56 + "lineNumber": 57 }, "signature": [ { @@ -9350,7 +9156,7 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/package_policy.ts", - "lineNumber": 57 + "lineNumber": 58 }, "signature": [ { @@ -9366,7 +9172,7 @@ ], "source": { "path": "x-pack/plugins/fleet/common/types/models/package_policy.ts", - "lineNumber": 49 + "lineNumber": 50 }, "initialIsOpen": false }, @@ -9385,7 +9191,7 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/package_policy.ts", - "lineNumber": 37 + "lineNumber": 38 } }, { @@ -9396,7 +9202,7 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/package_policy.ts", - "lineNumber": 38 + "lineNumber": 39 } }, { @@ -9407,7 +9213,7 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/package_policy.ts", - "lineNumber": 39 + "lineNumber": 40 }, "signature": [ "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", - "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": [ - { - "tags": [], - "id": "def-common.PostAgentEnrollRequest.body", - "type": "Object", - "label": "body", - "description": [], - "source": { - "path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts", - "lineNumber": 64 - }, - "signature": [ - "{ type: ", - { - "pluginId": "fleet", - "scope": "common", - "docId": "kibFleetPluginApi", - "section": "def-common.AgentType", - "text": "AgentType" - }, - "; metadata: { local: Record; user_provided: Record; }; }" - ] - } - ], - "source": { - "path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts", - "lineNumber": 63 - }, - "initialIsOpen": false - }, - { - "id": "def-common.PostAgentEnrollResponse", - "type": "Interface", - "label": "PostAgentEnrollResponse", - "description": [], - "tags": [], - "children": [ - { - "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", - "description": [], - "source": { - "path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts", - "lineNumber": 76 - }, - "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" - }, - "; }" - ] - } - ], - "source": { - "path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts", - "lineNumber": 73 + "lineNumber": 352 }, "initialIsOpen": false }, @@ -10547,7 +10106,7 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts", - "lineNumber": 106 + "lineNumber": 52 }, "signature": [ "{ agentId: string; }" @@ -10561,16 +10120,16 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts", - "lineNumber": 109 + "lineNumber": 55 }, "signature": [ - "{ force?: boolean | undefined; }" + "{ force?: boolean | undefined; revoke?: boolean | undefined; }" ] } ], "source": { "path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts", - "lineNumber": 105 + "lineNumber": 51 }, "initialIsOpen": false }, @@ -10583,7 +10142,7 @@ "children": [], "source": { "path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts", - "lineNumber": 115 + "lineNumber": 62 }, "initialIsOpen": false }, @@ -10602,7 +10161,7 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts", - "lineNumber": 133 + "lineNumber": 81 }, "signature": [ "{ agentId: string; }" @@ -10616,7 +10175,7 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts", - "lineNumber": 136 + "lineNumber": 84 }, "signature": [ "{ source_uri?: string | undefined; version: string; }" @@ -10625,7 +10184,7 @@ ], "source": { "path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts", - "lineNumber": 132 + "lineNumber": 80 }, "initialIsOpen": false }, @@ -10638,7 +10197,7 @@ "children": [], "source": { "path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts", - "lineNumber": 159 + "lineNumber": 107 }, "initialIsOpen": false }, @@ -10657,7 +10216,7 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts", - "lineNumber": 172 + "lineNumber": 120 }, "signature": [ "{ policy_id: string; agents: string | string[]; }" @@ -10666,7 +10225,7 @@ ], "source": { "path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts", - "lineNumber": 171 + "lineNumber": 119 }, "initialIsOpen": false }, @@ -10685,16 +10244,16 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts", - "lineNumber": 118 + "lineNumber": 65 }, "signature": [ - "{ agents: string | string[]; force?: boolean | undefined; }" + "{ agents: string | string[]; force?: boolean | undefined; revoke?: boolean | undefined; }" ] } ], "source": { "path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts", - "lineNumber": 117 + "lineNumber": 64 }, "initialIsOpen": false }, @@ -10713,7 +10272,7 @@ "description": [], "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; }" @@ -10722,7 +10281,7 @@ ], "source": { "path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts", - "lineNumber": 142 + "lineNumber": 90 }, "initialIsOpen": false }, @@ -10816,6 +10375,20 @@ "path": "x-pack/plugins/fleet/common/types/rest_spec/ingest_setup.ts", "lineNumber": 9 } + }, + { + "tags": [], + "id": "def-common.PostIngestSetupResponse.nonFatalErrors", + "type": "Array", + "label": "nonFatalErrors", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/rest_spec/ingest_setup.ts", + "lineNumber": 10 + }, + "signature": [ + "{ error: Error; }[] | undefined" + ] } ], "source": { @@ -10839,7 +10412,7 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts", - "lineNumber": 93 + "lineNumber": 39 }, "signature": [ "{ action: ", @@ -10861,7 +10434,7 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts", - "lineNumber": 96 + "lineNumber": 42 }, "signature": [ "{ agentId: string; }" @@ -10870,7 +10443,7 @@ ], "source": { "path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts", - "lineNumber": 92 + "lineNumber": 38 }, "initialIsOpen": false }, @@ -10889,7 +10462,7 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts", - "lineNumber": 102 + "lineNumber": 48 }, "signature": [ { @@ -10904,7 +10477,63 @@ ], "source": { "path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts", - "lineNumber": 101 + "lineNumber": 47 + }, + "initialIsOpen": false + }, + { + "id": "def-common.PreconfigurationError", + "type": "Interface", + "label": "PreconfigurationError", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.PreconfigurationError.package", + "type": "Object", + "label": "package", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/constants/preconfiguration.ts", + "lineNumber": 68 + }, + "signature": [ + "{ name: string; version: string; } | undefined" + ] + }, + { + "tags": [], + "id": "def-common.PreconfigurationError.agentPolicy", + "type": "Object", + "label": "agentPolicy", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/constants/preconfiguration.ts", + "lineNumber": 69 + }, + "signature": [ + "{ name: string; } | undefined" + ] + }, + { + "tags": [], + "id": "def-common.PreconfigurationError.error", + "type": "Object", + "label": "error", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/constants/preconfiguration.ts", + "lineNumber": 70 + }, + "signature": [ + "Error" + ] + } + ], + "source": { + "path": "x-pack/plugins/fleet/common/constants/preconfiguration.ts", + "lineNumber": 67 }, "initialIsOpen": false }, @@ -10928,7 +10557,7 @@ "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": [], @@ -10980,7 +10609,7 @@ "section": "def-common.NewPackagePolicy", "text": "NewPackagePolicy" }, - ", \"enabled\" | \"description\" | \"name\" | \"package\" | \"namespace\" | \"policy_id\" | \"output_id\">> & { name: string; package: Partial<", + ", \"enabled\" | \"description\" | \"name\" | \"namespace\" | \"policy_id\" | \"output_id\">> & { name: string; package: Partial<", { "pluginId": "fleet", "scope": "common", @@ -10988,67 +10617,21 @@ "section": "def-common.PackagePolicyPackage", "text": "PackagePolicyPackage" }, - ">; inputs?: ", + "> & { name: string; }; inputs?: ", { "pluginId": "fleet", "scope": "common", "docId": "kibFleetPluginApi", "section": "def-common.InputsOverride", - "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 - }, - "signature": [ - "boolean | undefined" + "text": "InputsOverride" + }, + "[] | undefined; })[]" ] } ], "source": { "path": "x-pack/plugins/fleet/common/types/models/preconfiguration.ts", - "lineNumber": 31 + "lineNumber": 19 }, "initialIsOpen": false }, @@ -11067,7 +10650,7 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts", - "lineNumber": 162 + "lineNumber": 110 }, "signature": [ "{ agentId: string; }" @@ -11081,7 +10664,7 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts", - "lineNumber": 165 + "lineNumber": 113 }, "signature": [ "{ policy_id: string; }" @@ -11090,7 +10673,7 @@ ], "source": { "path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts", - "lineNumber": 161 + "lineNumber": 109 }, "initialIsOpen": false }, @@ -11103,7 +10686,7 @@ "children": [], "source": { "path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts", - "lineNumber": 169 + "lineNumber": 117 }, "initialIsOpen": false }, @@ -11209,7 +10792,7 @@ "section": "def-common.Settings", "text": "Settings" }, - ", \"has_seen_add_data_notice\" | \"fleet_server_hosts\" | \"kibana_urls\" | \"kibana_ca_sha256\">>" + ", \"has_seen_add_data_notice\" | \"has_seen_fleet_migration_notice\" | \"fleet_server_hosts\">>" ] } ], @@ -11268,7 +10851,7 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 262 + "lineNumber": 267 } }, { @@ -11279,7 +10862,7 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 263 + "lineNumber": 268 }, "signature": [ "string | undefined" @@ -11293,7 +10876,7 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 264 + "lineNumber": 269 }, "signature": [ "boolean | undefined" @@ -11307,7 +10890,7 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 265 + "lineNumber": 270 } }, { @@ -11318,7 +10901,7 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 266 + "lineNumber": 271 } }, { @@ -11329,7 +10912,7 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 267 + "lineNumber": 272 } }, { @@ -11340,7 +10923,7 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 268 + "lineNumber": 273 }, "signature": [ { @@ -11361,7 +10944,7 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 269 + "lineNumber": 274 } }, { @@ -11372,7 +10955,7 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 270 + "lineNumber": 275 } }, { @@ -11383,7 +10966,7 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 271 + "lineNumber": 276 } }, { @@ -11394,7 +10977,7 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 272 + "lineNumber": 277 }, "signature": [ { @@ -11415,7 +10998,7 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 273 + "lineNumber": 278 }, "signature": [ "boolean | undefined" @@ -11424,7 +11007,7 @@ ], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 261 + "lineNumber": 266 }, "initialIsOpen": false }, @@ -11443,7 +11026,7 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 277 + "lineNumber": 282 }, "signature": [ "object | undefined" @@ -11457,7 +11040,7 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 278 + "lineNumber": 283 }, "signature": [ "object | undefined" @@ -11466,7 +11049,7 @@ ], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 276 + "lineNumber": 281 }, "initialIsOpen": false }, @@ -11485,7 +11068,7 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 117 + "lineNumber": 122 } }, { @@ -11496,7 +11079,7 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 118 + "lineNumber": 123 } }, { @@ -11507,7 +11090,7 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 119 + "lineNumber": 124 }, "signature": [ "string | undefined" @@ -11521,7 +11104,7 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 120 + "lineNumber": 125 }, "signature": [ "string | undefined" @@ -11535,7 +11118,7 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 121 + "lineNumber": 126 }, "signature": [ "string | undefined" @@ -11544,7 +11127,7 @@ ], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 116 + "lineNumber": 121 }, "initialIsOpen": false }, @@ -11563,7 +11146,7 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 150 + "lineNumber": 155 } }, { @@ -11574,7 +11157,7 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 151 + "lineNumber": 156 } }, { @@ -11585,7 +11168,7 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 152 + "lineNumber": 157 } }, { @@ -11596,7 +11179,7 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 153 + "lineNumber": 158 }, "signature": [ "string | undefined" @@ -11610,7 +11193,7 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 154 + "lineNumber": 159 }, "signature": [ "string | undefined" @@ -11624,7 +11207,7 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 155 + "lineNumber": 160 }, "signature": [ { @@ -11640,7 +11223,7 @@ ], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 149 + "lineNumber": 154 }, "initialIsOpen": false }, @@ -11659,7 +11242,7 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 133 + "lineNumber": 138 } }, { @@ -11670,7 +11253,7 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 134 + "lineNumber": 139 } }, { @@ -11681,7 +11264,7 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 135 + "lineNumber": 140 } }, { @@ -11692,7 +11275,7 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 136 + "lineNumber": 141 }, "signature": [ { @@ -11713,7 +11296,7 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 137 + "lineNumber": 142 }, "signature": [ "boolean | undefined" @@ -11722,7 +11305,7 @@ ], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 132 + "lineNumber": 137 }, "initialIsOpen": false }, @@ -11741,7 +11324,7 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 168 + "lineNumber": 173 } }, { @@ -11752,7 +11335,7 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 169 + "lineNumber": 174 } }, { @@ -11763,7 +11346,7 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 170 + "lineNumber": 175 }, "signature": [ "string | undefined" @@ -11777,7 +11360,7 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 171 + "lineNumber": 176 }, "signature": [ "boolean | undefined" @@ -11791,7 +11374,7 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 172 + "lineNumber": 177 }, "signature": [ { @@ -11812,13 +11395,13 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 173 + "lineNumber": 178 } } ], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 167 + "lineNumber": 172 }, "initialIsOpen": false }, @@ -11837,7 +11420,7 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 298 + "lineNumber": 303 } }, { @@ -11848,7 +11431,7 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 299 + "lineNumber": 304 }, "signature": [ "string | undefined" @@ -11862,7 +11445,7 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 300 + "lineNumber": 305 }, "signature": [ "string | undefined" @@ -11876,7 +11459,7 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 301 + "lineNumber": 306 }, "signature": [ { @@ -11896,7 +11479,7 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 302 + "lineNumber": 307 }, "signature": [ "boolean | undefined" @@ -11910,7 +11493,7 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 303 + "lineNumber": 308 }, "signature": [ "boolean | undefined" @@ -11924,7 +11507,7 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 304 + "lineNumber": 309 }, "signature": [ "boolean | undefined" @@ -11938,7 +11521,7 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 305 + "lineNumber": 310 }, "signature": [ "string | string[] | undefined" @@ -11952,7 +11535,7 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 306 + "lineNumber": 311 }, "signature": [ "{ [key: string]: { default: string | string[]; }; } | undefined" @@ -11961,7 +11544,7 @@ ], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 297 + "lineNumber": 302 }, "initialIsOpen": false }, @@ -11980,13 +11563,13 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 179 + "lineNumber": 184 } } ], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 178 + "lineNumber": 183 }, "initialIsOpen": false }, @@ -12022,13 +11605,13 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/settings.ts", - "lineNumber": 19 + "lineNumber": 17 } } ], "source": { "path": "x-pack/plugins/fleet/common/types/models/settings.ts", - "lineNumber": 18 + "lineNumber": 16 }, "initialIsOpen": false }, @@ -12060,7 +11643,7 @@ "children": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/settings.ts", - "lineNumber": 22 + "lineNumber": 20 }, "initialIsOpen": false }, @@ -12079,7 +11662,7 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 399 + "lineNumber": 404 } }, { @@ -12090,7 +11673,7 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 400 + "lineNumber": 405 }, "signature": [ { @@ -12105,7 +11688,7 @@ ], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 398 + "lineNumber": 403 }, "initialIsOpen": false }, @@ -12158,7 +11741,7 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts", - "lineNumber": 211 + "lineNumber": 141 }, "signature": [ "{ agentId: string; }" @@ -12172,7 +11755,7 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts", - "lineNumber": 214 + "lineNumber": 144 }, "signature": [ "{ user_provided_metadata: Record; }" @@ -12181,7 +11764,7 @@ ], "source": { "path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts", - "lineNumber": 210 + "lineNumber": 140 }, "initialIsOpen": false }, @@ -12217,7 +11800,7 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/package_policy.ts", - "lineNumber": 61 + "lineNumber": 62 }, "signature": [ "string | undefined" @@ -12226,7 +11809,7 @@ ], "source": { "path": "x-pack/plugins/fleet/common/types/models/package_policy.ts", - "lineNumber": 60 + "lineNumber": 61 }, "initialIsOpen": false } @@ -12240,7 +11823,7 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 71 + "lineNumber": 76 }, "initialIsOpen": false }, @@ -12264,7 +11847,7 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 46 + "lineNumber": 51 }, "initialIsOpen": false }, @@ -12276,7 +11859,7 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 60 + "lineNumber": 65 }, "initialIsOpen": false }, @@ -12288,7 +11871,7 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 246 + "lineNumber": 251 }, "initialIsOpen": false }, @@ -12300,7 +11883,7 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 140 + "lineNumber": 145 }, "initialIsOpen": false }, @@ -12312,7 +11895,7 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 124 + "lineNumber": 129 }, "initialIsOpen": false }, @@ -12324,7 +11907,7 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 158 + "lineNumber": 163 }, "initialIsOpen": false }, @@ -12336,7 +11919,7 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 282 + "lineNumber": 287 }, "initialIsOpen": false } @@ -12350,7 +11933,7 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/common/constants/agent.ts", - "lineNumber": 12 + "lineNumber": 9 }, "signature": [ "\"fleet-agent-actions\"" @@ -12365,28 +11948,13 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/common/constants/agent.ts", - "lineNumber": 30 + "lineNumber": 27 }, "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 - }, - "signature": [ - "\"fleet-agent-events\"" - ], - "initialIsOpen": false - }, { "tags": [], "id": "def-common.AGENT_POLICY_API_ROOT", @@ -12407,7 +11975,7 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/common/constants/agent_policy.ts", - "lineNumber": 13 + "lineNumber": 9 }, "signature": [ "\".fleet-policies\"" @@ -12422,7 +11990,7 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/common/constants/agent.ts", - "lineNumber": 26 + "lineNumber": 23 }, "signature": [ "1000" @@ -12437,7 +12005,7 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/common/constants/agent.ts", - "lineNumber": 27 + "lineNumber": 24 }, "signature": [ "5" @@ -12452,7 +12020,7 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/common/constants/agent_policy.ts", - "lineNumber": 12 + "lineNumber": 8 }, "signature": [ "\"ingest-agent-policies\"" @@ -12467,7 +12035,7 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/common/constants/agent.ts", - "lineNumber": 22 + "lineNumber": 19 }, "signature": [ "1000" @@ -12482,7 +12050,7 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/common/constants/agent.ts", - "lineNumber": 19 + "lineNumber": 16 }, "signature": [ "20000" @@ -12497,7 +12065,7 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/common/constants/agent.ts", - "lineNumber": 18 + "lineNumber": 15 }, "signature": [ "300000" @@ -12512,7 +12080,7 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/common/constants/agent.ts", - "lineNumber": 21 + "lineNumber": 18 }, "signature": [ "30000" @@ -12542,7 +12110,7 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/common/constants/agent.ts", - "lineNumber": 15 + "lineNumber": 12 }, "signature": [ "\"EPHEMERAL\"" @@ -12557,7 +12125,7 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/common/constants/agent.ts", - "lineNumber": 14 + "lineNumber": 11 }, "signature": [ "\"PERMANENT\"" @@ -12572,7 +12140,7 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/common/constants/agent.ts", - "lineNumber": 16 + "lineNumber": 13 }, "signature": [ "\"TEMPORARY\"" @@ -12587,7 +12155,7 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/common/constants/agent.ts", - "lineNumber": 24 + "lineNumber": 21 }, "signature": [ "5000" @@ -12602,7 +12170,7 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/common/constants/agent.ts", - "lineNumber": 23 + "lineNumber": 20 }, "signature": [ "30000" @@ -12647,28 +12215,13 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 40 + "lineNumber": 45 }, "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 - }, - "signature": [ - "NewAgentEvent" - ], - "initialIsOpen": false - }, { "id": "def-common.AgentPolicyActionSOAttributes", "type": "Type", @@ -12695,7 +12248,7 @@ "lineNumber": 71 }, "signature": [ - "Pick & { type: 'CONFIG_CHANGE'; data: { config: FullAgentPolicy;}; }" + "Pick & { type: 'CONFIG_CHANGE'; data: { config: FullAgentPolicy;}; }" ], "initialIsOpen": false }, @@ -12710,7 +12263,7 @@ "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; }" + "{ 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; }" ], "initialIsOpen": false }, @@ -12737,7 +12290,7 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/common/constants/agent.ts", - "lineNumber": 29 + "lineNumber": 26 }, "signature": [ "\".fleet-agents\"" @@ -12797,7 +12350,7 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 84 + "lineNumber": 89 }, "signature": [ "PackageSpecManifest & Pick" @@ -12812,7 +12365,7 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 362 + "lineNumber": 367 }, "signature": [ { @@ -12856,7 +12409,7 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 224 + "lineNumber": 229 }, "signature": [ "Record<\"kibana\", Record> & Record<\"elasticsearch\", Record>" @@ -12871,7 +12424,7 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 41 + "lineNumber": 46 }, "signature": [ "\"input\" | ", @@ -12925,7 +12478,7 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 223 + "lineNumber": 228 }, "signature": [ "Record & Record" @@ -12969,7 +12522,7 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 208 + "lineNumber": 213 }, "signature": [ "string" @@ -12984,7 +12537,7 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 207 + "lineNumber": 212 }, "signature": [ "CategorySummaryItem[]" @@ -13011,7 +12564,7 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 80 + "lineNumber": 85 }, "signature": [ "{ readonly Logs: \"logs\"; readonly Metrics: \"metrics\"; }" @@ -13020,16 +12573,16 @@ }, { "tags": [], - "id": "def-common.DEFAULT_AGENT_POLICIES_PACKAGES", + "id": "def-common.DEFAULT_PACKAGES", "type": "Array", - "label": "DEFAULT_AGENT_POLICIES_PACKAGES", + "label": "DEFAULT_PACKAGES", "description": [], "source": { - "path": "x-pack/plugins/fleet/common/constants/agent_policy.ts", - "lineNumber": 48 + "path": "x-pack/plugins/fleet/common/constants/preconfiguration.ts", + "lineNumber": 59 }, "signature": [ - "\"system\"[]" + "{ name: \"endpoint\" | \"fleet_server\" | \"system\" | \"elastic_agent\"; version: string; }[]" ], "initialIsOpen": false }, @@ -13041,10 +12594,10 @@ "description": [], "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\"; }" + "{ readonly System: \"system\"; readonly Endpoint: \"endpoint\"; readonly ElasticAgent: \"elastic_agent\"; readonly FleetServer: \"fleet_server\"; }" ], "initialIsOpen": false }, @@ -13071,7 +12624,7 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 38 + "lineNumber": 43 }, "signature": [ "\"custom\" | \"settings\" | \"overview\" | \"policies\"" @@ -13086,7 +12639,7 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 235 + "lineNumber": 240 }, "signature": [ "AssetParts & { service: Extract; type: ElasticsearchAssetType; }" @@ -13101,7 +12654,7 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 241 + "lineNumber": 246 }, "signature": [ "{ component_template: ElasticsearchAssetParts[]; ingest_pipeline: ElasticsearchAssetParts[]; index_template: ElasticsearchAssetParts[]; ilm_policy: ElasticsearchAssetParts[]; transform: ElasticsearchAssetParts[]; data_stream_ilm_policy: ElasticsearchAssetParts[]; }" @@ -13149,7 +12702,7 @@ "lineNumber": 18 }, "signature": [ - "{ name?: string | undefined; active: boolean; policy_id?: string | undefined; created_at: string; api_key: string; api_key_id: string; }" + "{ name?: string | undefined; active: boolean; created_at: string; policy_id?: string | undefined; api_key: string; api_key_id: string; }" ], "initialIsOpen": false }, @@ -13173,7 +12726,7 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 36 + "lineNumber": 41 }, "signature": [ "\"installed\" | \"installing\"" @@ -13188,7 +12741,7 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 367 + "lineNumber": 372 }, "signature": [ "Pick & { type: ElasticsearchAssetType; }" @@ -13218,7 +12771,7 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/common/constants/index.ts", - "lineNumber": 27 + "lineNumber": 28 }, "signature": [ "\".fleet-artifacts\"" @@ -13233,7 +12786,7 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/common/constants/index.ts", - "lineNumber": 29 + "lineNumber": 32 }, "signature": [ "string[]" @@ -13248,7 +12801,7 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/common/constants/index.ts", - "lineNumber": 25 + "lineNumber": 26 }, "signature": [ "1" @@ -13270,6 +12823,21 @@ ], "initialIsOpen": false }, + { + "tags": [], + "id": "def-common.FLEET_SERVER_SERVERS_INDEX", + "type": "string", + "label": "FLEET_SERVER_SERVERS_INDEX", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/constants/index.ts", + "lineNumber": 30 + }, + "signature": [ + "\".fleet-servers\"" + ], + "initialIsOpen": false + }, { "id": "def-common.GetAgentPoliciesResponseItem", "type": "Type", @@ -13331,7 +12899,7 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/common/constants/routes.ts", - "lineNumber": 121 + "lineNumber": 116 }, "initialIsOpen": false }, @@ -13343,7 +12911,7 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 351 + "lineNumber": 356 }, "signature": [ { @@ -13373,7 +12941,7 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 82 + "lineNumber": 87 }, "signature": [ { @@ -13417,7 +12985,7 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 353 + "lineNumber": 358 }, "signature": [ "T & { status: InstallationStatus['Installed']; savedObject: SavedObject; }" @@ -13432,7 +13000,7 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 34 + "lineNumber": 39 }, "signature": [ "\"registry\" | \"upload\"" @@ -13447,10 +13015,10 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 33 + "lineNumber": 38 }, "signature": [ - "\"update\" | \"reinstall\" | \"reupdate\" | \"rollback\" | \"install\"" + "\"update\" | \"unknown\" | \"reinstall\" | \"reupdate\" | \"rollback\" | \"install\"" ], "initialIsOpen": false }, @@ -13462,7 +13030,7 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 230 + "lineNumber": 235 }, "signature": [ "AssetParts & { service: Extract; type: KibanaAssetType; }" @@ -13477,7 +13045,7 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 364 + "lineNumber": 369 }, "signature": [ "Pick & { type: KibanaSavedObjectType; }" @@ -13492,7 +13060,7 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 240 + "lineNumber": 245 }, "signature": [ "{ dashboard: KibanaAssetParts[]; visualization: KibanaAssetParts[]; search: KibanaAssetParts[]; index_pattern: KibanaAssetParts[]; map: KibanaAssetParts[]; lens: KibanaAssetParts[]; security_rule: KibanaAssetParts[]; ml_module: KibanaAssetParts[]; }" @@ -13537,7 +13105,7 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 358 + "lineNumber": 363 }, "signature": [ "T & { status: InstallationStatus['NotInstalled']; }" @@ -13552,7 +13120,7 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/output.ts", - "lineNumber": 28 + "lineNumber": 26 }, "signature": [ "NewOutput & { id: string; }" @@ -13582,7 +13150,7 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/output.ts", - "lineNumber": 26 + "lineNumber": 24 }, "signature": [ "NewOutput" @@ -13639,7 +13207,7 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 371 + "lineNumber": 376 }, "signature": [ "Pick & { type: typeof ASSETS_SAVED_OBJECT_TYPE; }" @@ -13654,7 +13222,7 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 330 + "lineNumber": 335 }, "signature": [ { @@ -13707,7 +13275,7 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 326 + "lineNumber": 331 }, "signature": [ "Installable>[]" @@ -13722,7 +13290,7 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 328 + "lineNumber": 333 }, "signature": [ { @@ -13768,7 +13336,7 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/package_policy.ts", - "lineNumber": 19 + "lineNumber": 20 }, "signature": [ "{ [x: string]: PackagePolicyConfigRecordEntry; }" @@ -13783,10 +13351,10 @@ "description": [], "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; }" + "{ 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; }" ], "initialIsOpen": false }, @@ -13813,7 +13381,7 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 329 + "lineNumber": 334 }, "signature": [ "{ installed: PackageList; not_installed: PackageList; }" @@ -13831,7 +13399,7 @@ "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\"" + "\"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\"" ], "initialIsOpen": false }, @@ -13873,40 +13441,85 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts", - "lineNumber": 178 + "lineNumber": 126 + }, + "signature": [ + "{ [x: string]: { success: boolean; error?: string | undefined; }; }" + ], + "initialIsOpen": false + }, + { + "id": "def-common.PostBulkAgentUnenrollResponse", + "type": "Type", + "label": "PostBulkAgentUnenrollResponse", + "tags": [], + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts", + "lineNumber": 72 + }, + "signature": [ + "{ [x: string]: { success: boolean; error?: string | undefined; }; }" + ], + "initialIsOpen": false + }, + { + "id": "def-common.PostBulkAgentUpgradeResponse", + "type": "Type", + "label": "PostBulkAgentUpgradeResponse", + "tags": [], + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts", + "lineNumber": 98 + }, + "signature": [ + "{ [x: string]: { success: boolean; error?: string | undefined; }; }" + ], + "initialIsOpen": false + }, + { + "tags": [], + "id": "def-common.PRECONFIGURATION_DELETION_RECORD_SAVED_OBJECT_TYPE", + "type": "string", + "label": "PRECONFIGURATION_DELETION_RECORD_SAVED_OBJECT_TYPE", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/constants/preconfiguration.ts", + "lineNumber": 12 }, "signature": [ - "{ [x: string]: { success: boolean; error?: string | undefined; }; }" + "\"fleet-preconfiguration-deletion-record\"" ], "initialIsOpen": false }, { - "id": "def-common.PostBulkAgentUnenrollResponse", - "type": "Type", - "label": "PostBulkAgentUnenrollResponse", "tags": [], + "id": "def-common.PRECONFIGURATION_LATEST_KEYWORD", + "type": "string", + "label": "PRECONFIGURATION_LATEST_KEYWORD", "description": [], "source": { - "path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts", - "lineNumber": 124 + "path": "x-pack/plugins/fleet/common/constants/preconfiguration.ts", + "lineNumber": 15 }, "signature": [ - "{ [x: string]: { success: boolean; error?: string | undefined; }; }" + "\"latest\"" ], "initialIsOpen": false }, { - "id": "def-common.PostBulkAgentUpgradeResponse", + "id": "def-common.PreconfiguredPackage", "type": "Type", - "label": "PostBulkAgentUpgradeResponse", + "label": "PreconfiguredPackage", "tags": [], "description": [], "source": { - "path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts", - "lineNumber": 150 + "path": "x-pack/plugins/fleet/common/types/models/preconfiguration.ts", + "lineNumber": 31 }, "signature": [ - "{ [x: string]: { success: boolean; error?: string | undefined; }; }" + "{ name: string; version: string; }" ], "initialIsOpen": false }, @@ -13918,7 +13531,7 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 88 + "lineNumber": 93 }, "signature": [ "PackageSpecManifest & Partial> & RegistryAdditionalProperties & RegistryOverridePropertyValue" @@ -13933,7 +13546,7 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 115 + "lineNumber": 120 }, "signature": [ "\"experimental\" | \"beta\" | \"ga\"" @@ -13948,7 +13561,7 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 187 + "lineNumber": 192 }, "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?: (", @@ -13971,7 +13584,7 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 185 + "lineNumber": 190 }, "signature": [ "Pick[]" @@ -13986,13 +13599,28 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 281 + "lineNumber": 286 }, "signature": [ "\"string\" | \"text\" | \"password\" | \"integer\" | \"bool\" | \"yaml\"" ], "initialIsOpen": false }, + { + "tags": [], + "id": "def-common.REQUIRED_PACKAGES", + "type": "Array", + "label": "REQUIRED_PACKAGES", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/constants/preconfiguration.ts", + "lineNumber": 65 + }, + "signature": [ + "{ name: \"endpoint\" | \"fleet_server\" | \"system\" | \"elastic_agent\"; version: string; }[]" + ], + "initialIsOpen": false + }, { "id": "def-common.RequiredPackage", "type": "Type", @@ -14001,10 +13629,10 @@ "description": [], "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\"; }" + "{ readonly System: \"system\"; readonly Endpoint: \"endpoint\"; readonly ElasticAgent: \"elastic_agent\"; readonly FleetServer: \"fleet_server\"; }" ], "initialIsOpen": false }, @@ -14016,7 +13644,7 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 215 + "lineNumber": 220 }, "signature": [ "undefined | Record<\"kibana\", { version: string; }>" @@ -14031,7 +13659,7 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 176 + "lineNumber": 181 }, "signature": [ "string" @@ -14046,7 +13674,7 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 177 + "lineNumber": 182 }, "signature": [ "string" @@ -14061,7 +13689,7 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 203 + "lineNumber": 208 }, "signature": [ { @@ -14090,7 +13718,7 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 39 + "lineNumber": 44 }, "signature": [ "\"kibana\" | \"elasticsearch\"" @@ -14105,7 +13733,7 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/common/constants/routes.ts", - "lineNumber": 119 + "lineNumber": 114 }, "initialIsOpen": false }, @@ -14132,7 +13760,7 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/common/constants/index.ts", - "lineNumber": 23 + "lineNumber": 24 }, "signature": [ "10000" @@ -14194,7 +13822,7 @@ ], "source": { "path": "x-pack/plugins/fleet/common/types/index.ts", - "lineNumber": 47 + "lineNumber": 49 }, "signature": [ "T[keyof T]" @@ -14216,7 +13844,7 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/common/constants/routes.ts", - "lineNumber": 83 + "lineNumber": 84 } }, { @@ -14227,7 +13855,7 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/common/constants/routes.ts", - "lineNumber": 84 + "lineNumber": 85 } }, { @@ -14238,7 +13866,7 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/common/constants/routes.ts", - "lineNumber": 85 + "lineNumber": 86 } }, { @@ -14247,17 +13875,6 @@ "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", - "description": [], "source": { "path": "x-pack/plugins/fleet/common/constants/routes.ts", "lineNumber": 87 @@ -14389,54 +14006,7 @@ "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", - "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 - } - } - ], - "description": [], - "label": "AGENT_API_ROUTES_7_9", - "source": { - "path": "x-pack/plugins/fleet/common/constants/routes.ts", - "lineNumber": 100 + "lineNumber": 83 }, "initialIsOpen": false }, @@ -14550,7 +14120,7 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/common/constants/epm.ts", - "lineNumber": 23 + "lineNumber": 24 }, "signature": [ "{ readonly Input: \"input\"; }" @@ -14782,7 +14352,7 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/common/constants/agent_policy.ts", - "lineNumber": 14 + "lineNumber": 10 }, "signature": [ "{ readonly Active: \"active\"; readonly Inactive: \"inactive\"; }" @@ -14856,37 +14426,6 @@ "tags": [], "returnComment": [] }, - { - "id": "def-common.agentRouteService.getEventsPath", - "type": "Function", - "children": [ - { - "id": "def-common.agentRouteService.getEventsPath.$1", - "type": "string", - "label": "agentId", - "isRequired": true, - "signature": [ - "string" - ], - "description": [], - "source": { - "path": "x-pack/plugins/fleet/common/services/routes.ts", - "lineNumber": 137 - } - } - ], - "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", @@ -14902,7 +14441,7 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/common/services/routes.ts", - "lineNumber": 138 + "lineNumber": 137 } } ], @@ -14913,7 +14452,7 @@ "label": "getUnenrollPath", "source": { "path": "x-pack/plugins/fleet/common/services/routes.ts", - "lineNumber": 138 + "lineNumber": 137 }, "tags": [], "returnComment": [] @@ -14929,7 +14468,7 @@ "label": "getBulkUnenrollPath", "source": { "path": "x-pack/plugins/fleet/common/services/routes.ts", - "lineNumber": 140 + "lineNumber": 139 }, "tags": [], "returnComment": [] @@ -14949,7 +14488,7 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/common/services/routes.ts", - "lineNumber": 141 + "lineNumber": 140 } } ], @@ -14960,7 +14499,7 @@ "label": "getReassignPath", "source": { "path": "x-pack/plugins/fleet/common/services/routes.ts", - "lineNumber": 141 + "lineNumber": 140 }, "tags": [], "returnComment": [] @@ -14976,7 +14515,7 @@ "label": "getBulkReassignPath", "source": { "path": "x-pack/plugins/fleet/common/services/routes.ts", - "lineNumber": 143 + "lineNumber": 142 }, "tags": [], "returnComment": [] @@ -14996,7 +14535,7 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/common/services/routes.ts", - "lineNumber": 144 + "lineNumber": 143 } } ], @@ -15007,7 +14546,7 @@ "label": "getUpgradePath", "source": { "path": "x-pack/plugins/fleet/common/services/routes.ts", - "lineNumber": 144 + "lineNumber": 143 }, "tags": [], "returnComment": [] @@ -15023,7 +14562,7 @@ "label": "getBulkUpgradePath", "source": { "path": "x-pack/plugins/fleet/common/services/routes.ts", - "lineNumber": 146 + "lineNumber": 145 }, "tags": [], "returnComment": [] @@ -15039,7 +14578,7 @@ "label": "getListPath", "source": { "path": "x-pack/plugins/fleet/common/services/routes.ts", - "lineNumber": 147 + "lineNumber": 146 }, "tags": [], "returnComment": [] @@ -15055,7 +14594,7 @@ "label": "getStatusPath", "source": { "path": "x-pack/plugins/fleet/common/services/routes.ts", - "lineNumber": 148 + "lineNumber": 147 }, "tags": [], "returnComment": [] @@ -15075,7 +14614,7 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/common/services/routes.ts", - "lineNumber": 149 + "lineNumber": 148 } } ], @@ -15086,7 +14625,7 @@ "label": "getCreateActionPath", "source": { "path": "x-pack/plugins/fleet/common/services/routes.ts", - "lineNumber": 149 + "lineNumber": 148 }, "tags": [], "returnComment": [] @@ -15113,7 +14652,7 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/common/constants/routes.ts", - "lineNumber": 115 + "lineNumber": 110 } }, { @@ -15124,7 +14663,7 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/common/constants/routes.ts", - "lineNumber": 116 + "lineNumber": 111 } } ], @@ -15132,7 +14671,7 @@ "label": "AGENTS_SETUP_API_ROUTES", "source": { "path": "x-pack/plugins/fleet/common/constants/routes.ts", - "lineNumber": 114 + "lineNumber": 109 }, "initialIsOpen": false }, @@ -15167,6 +14706,17 @@ "path": "x-pack/plugins/fleet/common/constants/routes.ts", "lineNumber": 78 } + }, + { + "tags": [], + "id": "def-common.APP_API_ROUTES.GENERATE_SERVICE_TOKEN_PATTERN", + "type": "string", + "label": "GENERATE_SERVICE_TOKEN_PATTERN", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/constants/routes.ts", + "lineNumber": 79 + } } ], "description": [], @@ -15191,6 +14741,22 @@ ], "description": [], "label": "getCheckPermissionsPath", + "source": { + "path": "x-pack/plugins/fleet/common/services/routes.ts", + "lineNumber": 165 + }, + "tags": [], + "returnComment": [] + }, + { + "id": "def-common.appRoutesService.getRegenerateServiceTokenPath", + "type": "Function", + "children": [], + "signature": [ + "() => string" + ], + "description": [], + "label": "getRegenerateServiceTokenPath", "source": { "path": "x-pack/plugins/fleet/common/services/routes.ts", "lineNumber": 166 @@ -15203,7 +14769,7 @@ "label": "appRoutesService", "source": { "path": "x-pack/plugins/fleet/common/services/routes.ts", - "lineNumber": 165 + "lineNumber": 164 }, "initialIsOpen": false }, @@ -15270,7 +14836,7 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/common/constants/epm.ts", - "lineNumber": 27 + "lineNumber": 28 }, "signature": [ "{ readonly Logs: \"logs\"; readonly Metrics: \"metrics\"; }" @@ -15289,8 +14855,8 @@ "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 } }, { @@ -15300,8 +14866,8 @@ "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 } }, { @@ -15311,24 +14877,10 @@ "label": "description", "description": [], "source": { - "path": "x-pack/plugins/fleet/common/constants/agent_policy.ts", - "lineNumber": 25 + "path": "x-pack/plugins/fleet/common/constants/preconfiguration.ts", + "lineNumber": 27 } }, - { - "tags": [], - "id": "def-common.DEFAULT_AGENT_POLICY.status", - "type": "string", - "label": "status", - "description": [], - "source": { - "path": "x-pack/plugins/fleet/common/constants/agent_policy.ts", - "lineNumber": 26 - }, - "signature": [ - "\"active\"" - ] - }, { "tags": [], "id": "def-common.DEFAULT_AGENT_POLICY.package_policies", @@ -15336,11 +14888,11 @@ "label": "package_policies", "description": [], "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[]" + "{ name: string; package: { name: \"system\"; }; }[]" ] }, { @@ -15350,8 +14902,8 @@ "label": "is_default", "description": [], "source": { - "path": "x-pack/plugins/fleet/common/constants/agent_policy.ts", - "lineNumber": 28 + "path": "x-pack/plugins/fleet/common/constants/preconfiguration.ts", + "lineNumber": 36 }, "signature": [ "true" @@ -15364,8 +14916,8 @@ "label": "is_managed", "description": [], "source": { - "path": "x-pack/plugins/fleet/common/constants/agent_policy.ts", - "lineNumber": 29 + "path": "x-pack/plugins/fleet/common/constants/preconfiguration.ts", + "lineNumber": 37 }, "signature": [ "false" @@ -15378,8 +14930,8 @@ "label": "monitoring_enabled", "description": [], "source": { - "path": "x-pack/plugins/fleet/common/constants/agent_policy.ts", - "lineNumber": 30 + "path": "x-pack/plugins/fleet/common/constants/preconfiguration.ts", + "lineNumber": 38 }, "signature": [ "(\"metrics\" | \"logs\")[]" @@ -15389,8 +14941,8 @@ "description": [], "label": "DEFAULT_AGENT_POLICY", "source": { - "path": "x-pack/plugins/fleet/common/constants/agent_policy.ts", - "lineNumber": 19 + "path": "x-pack/plugins/fleet/common/constants/preconfiguration.ts", + "lineNumber": 24 }, "initialIsOpen": false }, @@ -15406,8 +14958,8 @@ "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 } }, { @@ -15417,8 +14969,8 @@ "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 } }, { @@ -15428,24 +14980,10 @@ "label": "description", "description": [], "source": { - "path": "x-pack/plugins/fleet/common/constants/agent_policy.ts", - "lineNumber": 39 + "path": "x-pack/plugins/fleet/common/constants/preconfiguration.ts", + "lineNumber": 44 } }, - { - "tags": [], - "id": "def-common.DEFAULT_FLEET_SERVER_AGENT_POLICY.status", - "type": "string", - "label": "status", - "description": [], - "source": { - "path": "x-pack/plugins/fleet/common/constants/agent_policy.ts", - "lineNumber": 40 - }, - "signature": [ - "\"active\"" - ] - }, { "tags": [], "id": "def-common.DEFAULT_FLEET_SERVER_AGENT_POLICY.package_policies", @@ -15453,11 +14991,11 @@ "label": "package_policies", "description": [], "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[]" + "{ name: string; package: { name: \"fleet_server\"; }; }[]" ] }, { @@ -15467,8 +15005,8 @@ "label": "is_default", "description": [], "source": { - "path": "x-pack/plugins/fleet/common/constants/agent_policy.ts", - "lineNumber": 42 + "path": "x-pack/plugins/fleet/common/constants/preconfiguration.ts", + "lineNumber": 53 }, "signature": [ "false" @@ -15481,8 +15019,8 @@ "label": "is_default_fleet_server", "description": [], "source": { - "path": "x-pack/plugins/fleet/common/constants/agent_policy.ts", - "lineNumber": 43 + "path": "x-pack/plugins/fleet/common/constants/preconfiguration.ts", + "lineNumber": 54 }, "signature": [ "true" @@ -15495,8 +15033,8 @@ "label": "is_managed", "description": [], "source": { - "path": "x-pack/plugins/fleet/common/constants/agent_policy.ts", - "lineNumber": 44 + "path": "x-pack/plugins/fleet/common/constants/preconfiguration.ts", + "lineNumber": 55 }, "signature": [ "false" @@ -15509,8 +15047,8 @@ "label": "monitoring_enabled", "description": [], "source": { - "path": "x-pack/plugins/fleet/common/constants/agent_policy.ts", - "lineNumber": 45 + "path": "x-pack/plugins/fleet/common/constants/preconfiguration.ts", + "lineNumber": 56 }, "signature": [ "(\"metrics\" | \"logs\")[]" @@ -15520,8 +15058,8 @@ "description": [], "label": "DEFAULT_FLEET_SERVER_AGENT_POLICY", "source": { - "path": "x-pack/plugins/fleet/common/constants/agent_policy.ts", - "lineNumber": 33 + "path": "x-pack/plugins/fleet/common/constants/preconfiguration.ts", + "lineNumber": 41 }, "initialIsOpen": false }, @@ -15600,10 +15138,10 @@ "description": [], "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\"; }" + "{ readonly System: \"system\"; readonly Endpoint: \"endpoint\"; readonly ElasticAgent: \"elastic_agent\"; readonly FleetServer: \"fleet_server\"; }" ], "initialIsOpen": false }, @@ -15620,7 +15158,7 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/common/constants/routes.ts", - "lineNumber": 107 + "lineNumber": 102 } }, { @@ -15631,7 +15169,7 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/common/constants/routes.ts", - "lineNumber": 108 + "lineNumber": 103 } }, { @@ -15642,7 +15180,7 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/common/constants/routes.ts", - "lineNumber": 109 + "lineNumber": 104 } }, { @@ -15653,7 +15191,7 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/common/constants/routes.ts", - "lineNumber": 110 + "lineNumber": 105 } } ], @@ -15661,7 +15199,7 @@ "label": "ENROLLMENT_API_KEY_ROUTES", "source": { "path": "x-pack/plugins/fleet/common/constants/routes.ts", - "lineNumber": 106 + "lineNumber": 101 }, "initialIsOpen": false }, @@ -16184,7 +15722,7 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/common/constants/epm.ts", - "lineNumber": 32 + "lineNumber": 33 }, "signature": [ "{ readonly Installed: \"installed\"; readonly NotInstalled: \"not_installed\"; }" @@ -16258,7 +15796,7 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/common/services/routes.ts", - "lineNumber": 154 + "lineNumber": 153 } } ], @@ -16269,7 +15807,7 @@ "label": "getInfoPath", "source": { "path": "x-pack/plugins/fleet/common/services/routes.ts", - "lineNumber": 154 + "lineNumber": 153 }, "tags": [], "returnComment": [] @@ -16289,7 +15827,7 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/common/services/routes.ts", - "lineNumber": 155 + "lineNumber": 154 } } ], @@ -16300,7 +15838,7 @@ "label": "getUpdatePath", "source": { "path": "x-pack/plugins/fleet/common/services/routes.ts", - "lineNumber": 155 + "lineNumber": 154 }, "tags": [], "returnComment": [] @@ -16316,7 +15854,7 @@ "label": "getListPath", "source": { "path": "x-pack/plugins/fleet/common/services/routes.ts", - "lineNumber": 157 + "lineNumber": 156 }, "tags": [], "returnComment": [] @@ -16326,7 +15864,7 @@ "label": "outputRoutesService", "source": { "path": "x-pack/plugins/fleet/common/services/routes.ts", - "lineNumber": 153 + "lineNumber": 152 }, "initialIsOpen": false }, @@ -16551,7 +16089,7 @@ "description": [], "source": { "path": "x-pack/plugins/fleet/common/constants/routes.ts", - "lineNumber": 125 + "lineNumber": 120 } } ], @@ -16559,7 +16097,7 @@ "label": "PRECONFIGURATION_API_ROUTES", "source": { "path": "x-pack/plugins/fleet/common/constants/routes.ts", - "lineNumber": 124 + "lineNumber": 119 }, "initialIsOpen": false }, @@ -16574,7 +16112,7 @@ "lineNumber": 14 }, "signature": [ - "{ readonly System: \"system\"; readonly Endpoint: \"endpoint\"; readonly ElasticAgent: \"elastic_agent\"; }" + "{ readonly System: \"system\"; readonly Endpoint: \"endpoint\"; readonly ElasticAgent: \"elastic_agent\"; readonly FleetServer: \"fleet_server\"; }" ], "initialIsOpen": false }, @@ -16630,7 +16168,7 @@ "label": "getInfoPath", "source": { "path": "x-pack/plugins/fleet/common/services/routes.ts", - "lineNumber": 161 + "lineNumber": 160 }, "tags": [], "returnComment": [] @@ -16646,7 +16184,7 @@ "label": "getUpdatePath", "source": { "path": "x-pack/plugins/fleet/common/services/routes.ts", - "lineNumber": 162 + "lineNumber": 161 }, "tags": [], "returnComment": [] @@ -16656,7 +16194,7 @@ "label": "settingsRoutesService", "source": { "path": "x-pack/plugins/fleet/common/services/routes.ts", - "lineNumber": 160 + "lineNumber": 159 }, "initialIsOpen": false }, diff --git a/api_docs/infra.json b/api_docs/infra.json index a9511cd9a7c80..4b7ae39d21b65 100644 --- a/api_docs/infra.json +++ b/api_docs/infra.json @@ -193,10 +193,25 @@ "description": [], "source": { "path": "x-pack/plugins/infra/server/plugin.ts", - "lineNumber": 64 + "lineNumber": 65 }, "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; }>; }" + "{ 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; }>; }" + ], + "initialIsOpen": false + }, + { + "id": "def-server.InfraRequestHandlerContext", + "type": "Type", + "label": "InfraRequestHandlerContext", + "tags": [], + "description": [], + "source": { + "path": "x-pack/plugins/infra/server/types.ts", + "lineNumber": 24 + }, + "signature": [ + "InfraMlRequestHandlerContext & InfraSpacesRequestHandlerContext" ], "initialIsOpen": false } @@ -217,7 +232,7 @@ "description": [], "source": { "path": "x-pack/plugins/infra/server/plugin.ts", - "lineNumber": 75 + "lineNumber": 76 }, "signature": [ "(sourceId: string, sourceProperties: ", @@ -228,7 +243,7 @@ ], "source": { "path": "x-pack/plugins/infra/server/plugin.ts", - "lineNumber": 74 + "lineNumber": 75 }, "lifecycle": "setup", "initialIsOpen": true diff --git a/api_docs/kibana_react.json b/api_docs/kibana_react.json index 1085cf8f14bbd..8215c584f5be9 100644 --- a/api_docs/kibana_react.json +++ b/api_docs/kibana_react.json @@ -616,7 +616,7 @@ "description": [], "source": { "path": "src/plugins/kibana_react/public/code_editor/index.tsx", - "lineNumber": 22 + "lineNumber": 34 } } ], @@ -625,11 +625,53 @@ "Props", ">) => JSX.Element" ], - "description": [], + "description": [ + "\nRenders a Monaco code editor with EUI color theme.\n" + ], "label": "CodeEditor", "source": { "path": "src/plugins/kibana_react/public/code_editor/index.tsx", - "lineNumber": 22 + "lineNumber": 34 + }, + "tags": [ + "see" + ], + "returnComment": [], + "initialIsOpen": false + }, + { + "id": "def-public.CodeEditorField", + "type": "Function", + "children": [ + { + "id": "def-public.CodeEditorField.$1", + "type": "CompoundType", + "label": "props", + "isRequired": true, + "signature": [ + "React.PropsWithChildren<", + "Props", + ">" + ], + "description": [], + "source": { + "path": "src/plugins/kibana_react/public/code_editor/index.tsx", + "lineNumber": 48 + } + } + ], + "signature": [ + "(props: React.PropsWithChildren<", + "Props", + ">) => JSX.Element" + ], + "description": [ + "\nRenders a Monaco code editor in the same style as other EUI form fields." + ], + "label": "CodeEditorField", + "source": { + "path": "src/plugins/kibana_react/public/code_editor/index.tsx", + "lineNumber": 48 }, "tags": [], "returnComment": [], @@ -2854,7 +2896,7 @@ "lineNumber": 15 }, "signature": [ - "\"warning\" | \"primary\" | \"success\" | \"danger\" | undefined" + "\"warning\" | \"success\" | \"primary\" | \"danger\" | undefined" ] }, { @@ -3915,7 +3957,7 @@ "lineNumber": 17 }, "signature": [ - "{ paddingSizes: { xs: string; s: string; m: string; l: string; xl: string; }; avatarSizing: { s: { size: string; 'font-size': string; }; m: { size: string; 'font-size': string; }; l: { size: string; 'font-size': string; }; xl: { size: string; 'font-size': string; }; }; euiBadgeGroupGutterTypes: { gutterExtraSmall: string; gutterSmall: string; }; euiBreadcrumbSpacing: string; euiBreadcrumbTruncateWidth: string; euiButtonEmptyTypes: { primary: string; danger: string; disabled: string; ghost: string; text: string; success: string; warning: string; }; euiButtonIconTypes: { accent: string; danger: string; ghost: string; primary: string; subdued: string; success: string; text: string; warning: string; }; euiCallOutTypes: { primary: string; success: string; warning: string; danger: string; }; euiCardSpacing: string; euiCardBottomNodeHeight: string; euiCardSelectButtonBorders: { text: string; primary: string; success: string; danger: string; ghost: string; }; euiCardSelectButtonBackgrounds: { text: string; primary: string; success: string; danger: string; ghost: string; }; euiCardPaddingModifiers: { paddingNone: number; paddingSmall: string; paddingMedium: string; paddingLarge: string; }; euiCollapsibleNavWidth: string; euiCollapsibleNavGroupLightBackgroundColor: string; euiCollapsibleNavGroupDarkBackgroundColor: string; euiCollapsibleNavGroupDarkHighContrastColor: string; euiColorPickerValueRange0: string; euiColorPickerValueRange1: string; euiColorPickerSaturationRange0: string; euiColorPickerSaturationRange1: string; euiColorPickerIndicatorSize: string; euiColorPickerWidth: string; euiColorPaletteDisplaySizes: { sizeExtraSmall: string; sizeSmall: string; sizeMedium: string; }; euiContextMenuWidth: string; euiControlBarBackground: string; euiControlBarText: string; euiControlBarBorderColor: string; euiControlBarInitialHeight: string; euiControlBarMaxHeight: string; euiControlBarHeights: { s: string; m: string; l: string; }; euiDataGridPrefix: string; euiDataGridStyles: string; euiDataGridColumnResizerWidth: string; euiDataGridPopoverMaxHeight: string; euiDataGridCellPaddingS: string; euiDataGridCellPaddingM: string; euiDataGridCellPaddingL: string; euiDataGridVerticalBorder: string; euiDatePickerCalendarWidth: string; euiSuperDatePickerWidth: string; euiSuperDatePickerButtonWidth: string; euiDragAndDropSpacing: { s: string; m: string; l: string; }; euiExpressionColors: { subdued: string; primary: string; secondary: string; warning: string; danger: string; accent: string; }; euiFacetGutterSizes: { gutterNone: number; gutterSmall: string; gutterMedium: string; gutterLarge: string; }; gutterTypes: { gutterExtraSmall: string; gutterSmall: string; gutterMedium: string; gutterLarge: string; gutterExtraLarge: string; }; fractions: { fourths: { percentage: string; count: number; }; thirds: { percentage: string; count: number; }; halves: { percentage: string; count: number; }; single: { percentage: string; count: number; }; }; flyoutSizes: { small: { min: string; width: string; max: string; }; medium: { min: string; width: string; max: string; }; large: { min: string; width: string; max: string; }; }; euiFlyoutBorder: string; euiFlyoutPaddingModifiers: { paddingNone: number; paddingSmall: string; paddingMedium: string; paddingLarge: string; }; euiFilePickerTallHeight: string; euiRangeLevelColors: { primary: string; success: string; warning: string; danger: string; }; textareaResizing: { vertical: string; horizontal: string; both: string; none: string; }; euiHeaderLinksGutterSizes: { gutterXS: string; gutterS: string; gutterM: string; gutterL: string; }; ruleMargins: { marginXSmall: string; marginSmall: string; marginMedium: string; marginLarge: string; marginXLarge: string; marginXXLarge: string; }; euiIconLoadingOpacity: number; euiIconColors: { accent: string; danger: string; ghost: string; primary: string; secondary: string; success: string; subdued: string; text: string; warning: string; }; euiIconSizes: { small: string; medium: string; large: string; xLarge: string; xxLarge: string; }; euiKeyPadMenuSize: string; euiKeyPadMenuItemBetaBadgeSize: string; euiLinkColors: { subdued: string; primary: string; secondary: string; accent: string; warning: string; danger: string; text: string; ghost: string; }; euiListGroupItemHoverBackground: string; euiListGroupItemHoverBackgroundGhost: string; euiListGroupGutterTypes: { gutterSmall: string; gutterMedium: string; }; euiListGroupItemColorTypes: { primary: string; text: string; subdued: string; ghost: string; }; euiListGroupItemSizeTypes: { xSmall: string; small: string; medium: string; large: string; }; euiGradientStartStop: string; euiGradientMiddle: string; browserDefaultFontSize: string; euiMarkdownEditorMinHeight: string; euiPopoverArrowSize: string; euiPopoverTranslateDistance: string; euiProgressSizes: { xs: string; s: string; m: string; l: string; }; euiProgressColors: { primary: string; secondary: string; success: string; warning: string; danger: string; accent: string; subdued: string; vis0: string; vis1: string; vis2: string; vis3: string; vis4: string; vis5: string; vis6: string; vis7: string; vis8: string; vis9: string; customColor: string; }; euiResizableButtonTransitionSpeed: string; euiResizableButtonSize: string; euiSelectableListItemBorder: string; euiSelectableListItemPadding: string; euiSelectableTemplateSitewideTypes: { application: { color: string; 'font-weight': number; }; deployment: { color: string; 'font-weight': number; }; article: { color: string; 'font-weight': number; }; case: { color: string; 'font-weight': number; }; platform: { color: string; 'font-weight': number; }; }; euiSideNavEmphasizedBackgroundColor: string; euiSideNavRootTextcolor: string; euiSideNavBranchTextcolor: string; euiSideNavSelectedTextcolor: string; spacerSizes: { xs: string; s: string; m: string; l: string; xl: string; xxl: string; }; euiStepNumberSize: string; euiStepNumberSmallSize: string; euiStepNumberMargin: string; euiStepStatusColorsToFade: { warning: string; danger: string; disabled: string; incomplete: string; }; euiSuggestItemColors: { tint0: string; tint1: string; tint2: string; tint3: string; tint4: string; tint5: string; tint6: string; tint7: string; tint8: string; tint9: string; tint10: string; }; euiTableCellContentPadding: string; euiTableCellContentPaddingCompressed: string; euiTableCellCheckboxWidth: string; euiTableActionsAreaWidth: string; euiTableHoverColor: string; euiTableSelectedColor: string; euiTableHoverSelectedColor: string; euiTableActionsBorderColor: string; euiTableHoverClickableColor: string; euiTableFocusClickableColor: string; euiTabFontSize: string; euiTabFontSizeS: string; euiTabFontSizeL: string; euiTextColors: { default: string; subdued: string; secondary: string; accent: string; warning: string; danger: string; ghost: string; }; euiTextConstrainedMaxWidth: string; euiToastWidth: string; euiToastTypes: { primary: string; success: string; warning: string; danger: string; }; euiTokenGrayColor: string; euiTokenTypes: { euiColorVis0: { graphic: string; behindText: string; }; euiColorVis1: { graphic: string; behindText: string; }; euiColorVis2: { graphic: string; behindText: string; }; euiColorVis3: { graphic: string; behindText: string; }; euiColorVis4: { graphic: string; behindText: string; }; euiColorVis5: { graphic: string; behindText: string; }; euiColorVis6: { graphic: string; behindText: string; }; euiColorVis7: { graphic: string; behindText: string; }; euiColorVis8: { graphic: string; behindText: string; }; euiColorVis9: { graphic: string; behindText: string; }; gray: { graphic: string; behindText: string; }; }; euiTokenTypeKeys: string; euiAnimSlightBounce: string; euiAnimSlightResistance: string; euiAnimSpeedExtraFast: string; euiAnimSpeedFast: string; euiAnimSpeedNormal: string; euiAnimSpeedSlow: string; euiAnimSpeedExtraSlow: string; euiBorderWidthThin: string; euiBorderWidthThick: string; euiBorderColor: string; euiBorderRadius: string; euiBorderRadiusSmall: string; euiBorderThick: string; euiBorderThin: string; euiBorderEditable: string; euiButtonHeight: string; euiButtonHeightSmall: string; euiButtonHeightXSmall: string; euiButtonColorDisabled: string; euiButtonColorDisabledText: string; euiButtonColorGhostDisabled: string; euiButtonTypes: { primary: string; secondary: string; warning: string; danger: string; ghost: string; text: string; }; euiColorGhost: string; euiColorInk: string; euiColorPrimary: string; euiColorSecondary: string; euiColorAccent: string; euiColorSuccess: string; euiColorWarning: string; euiColorDanger: string; euiColorEmptyShade: string; euiColorLightestShade: string; euiColorLightShade: string; euiColorMediumShade: string; euiColorDarkShade: string; euiColorDarkestShade: string; euiColorFullShade: string; euiPageBackgroundColor: string; euiColorHighlight: string; euiTextColor: string; euiTitleColor: string; euiTextSubduedColor: string; euiColorDisabled: string; euiColorPrimaryText: string; euiColorSecondaryText: string; euiColorAccentText: string; euiColorWarningText: string; euiColorDangerText: string; euiColorDisabledText: string; euiColorSuccessText: string; euiLinkColor: string; euiPaletteColorBlind: { euiColorVis0: { graphic: string; behindText: string; }; euiColorVis1: { graphic: string; behindText: string; }; euiColorVis2: { graphic: string; behindText: string; }; euiColorVis3: { graphic: string; behindText: string; }; euiColorVis4: { graphic: string; behindText: string; }; euiColorVis5: { graphic: string; behindText: string; }; euiColorVis6: { graphic: string; behindText: string; }; euiColorVis7: { graphic: string; behindText: string; }; euiColorVis8: { graphic: string; behindText: string; }; euiColorVis9: { graphic: string; behindText: string; }; }; euiPaletteColorBlindKeys: string; euiColorVis0: string; euiColorVis1: string; euiColorVis2: string; euiColorVis3: string; euiColorVis4: string; euiColorVis5: string; euiColorVis6: string; euiColorVis7: string; euiColorVis8: string; euiColorVis9: string; euiColorVis0_behindText: string; euiColorVis1_behindText: string; euiColorVis2_behindText: string; euiColorVis3_behindText: string; euiColorVis4_behindText: string; euiColorVis5_behindText: string; euiColorVis6_behindText: string; euiColorVis7_behindText: string; euiColorVis8_behindText: string; euiColorVis9_behindText: string; euiColorChartLines: string; euiColorChartBand: string; euiCodeBlockBackgroundColor: string; euiCodeBlockColor: string; euiCodeBlockSelectedBackgroundColor: string; euiCodeBlockCommentColor: string; euiCodeBlockSelectorTagColor: string; euiCodeBlockStringColor: string; euiCodeBlockTagColor: string; euiCodeBlockNameColor: string; euiCodeBlockNumberColor: string; euiCodeBlockKeywordColor: string; euiCodeBlockFunctionTitleColor: string; euiCodeBlockTypeColor: string; euiCodeBlockAttributeColor: string; euiCodeBlockSymbolColor: string; euiCodeBlockParamsColor: string; euiCodeBlockMetaColor: string; euiCodeBlockTitleColor: string; euiCodeBlockSectionColor: string; euiCodeBlockAdditionColor: string; euiCodeBlockDeletionColor: string; euiCodeBlockSelectorClassColor: string; euiCodeBlockSelectorIdColor: string; euiFormMaxWidth: string; euiFormControlHeight: string; euiFormControlCompressedHeight: string; euiFormControlPadding: string; euiFormControlCompressedPadding: string; euiFormControlBorderRadius: number; euiFormControlCompressedBorderRadius: string; euiRadioSize: string; euiCheckBoxSize: string; euiCheckboxBorderRadius: string; euiSwitchHeight: string; euiSwitchWidth: string; euiSwitchThumbSize: string; euiSwitchIconHeight: string; euiSwitchHeightCompressed: string; euiSwitchWidthCompressed: string; euiSwitchThumbSizeCompressed: string; euiSwitchHeightMini: string; euiSwitchWidthMini: string; euiSwitchThumbSizeMini: string; euiFormBackgroundColor: string; euiFormBackgroundDisabledColor: string; euiFormBackgroundReadOnlyColor: string; euiFormBorderOpaqueColor: string; euiFormBorderColor: string; euiFormBorderDisabledColor: string; euiFormCustomControlDisabledIconColor: string; euiFormCustomControlBorderColor: string; euiFormControlDisabledColor: string; euiFormControlBoxShadow: string; euiFormInputGroupLabelBackground: string; euiFormInputGroupBorder: string; euiSwitchOffColor: string; euiFormControlLayoutGroupInputHeight: string; euiFormControlLayoutGroupInputCompressedHeight: string; euiFormControlLayoutGroupInputCompressedBorderRadius: string; euiRangeTrackColor: string; euiRangeThumbRadius: string; euiRangeThumbHeight: string; euiRangeThumbWidth: string; euiRangeThumbBorderColor: string; euiRangeTrackWidth: string; euiRangeTrackHeight: string; euiRangeTrackBorderWidth: number; euiRangeTrackBorderColor: string; euiRangeTrackRadius: string; euiRangeDisabledOpacity: number; euiRangeHighlightHeight: string; euiHeaderBackgroundColor: string; euiHeaderBorderColor: string; euiHeaderBreadcrumbColor: string; euiHeaderHeight: string; euiHeaderChildSize: string; euiHeaderHeightCompensation: string; euiPageDefaultMaxWidth: string; euiPageSidebarMinWidth: string; euiPanelPaddingModifiers: { paddingSmall: string; paddingMedium: string; paddingLarge: string; }; euiPanelBorderRadiusModifiers: { borderRadiusNone: number; borderRadiusMedium: string; }; euiPanelBackgroundColorModifiers: { transparent: string; plain: string; subdued: string; accent: string; primary: string; success: string; warning: string; danger: string; }; euiBreakpoints: { xs: number; s: string; m: string; l: string; xl: string; }; euiBreakpointKeys: string; euiShadowColor: string; euiShadowColorLarge: string; euiSize: string; euiSizeXS: string; euiSizeS: string; euiSizeM: string; euiSizeL: string; euiSizeXL: string; euiSizeXXL: string; euiButtonMinWidth: string; euiScrollBar: string; euiScrollBarCorner: string; euiFocusRingColor: string; euiFocusRingAnimStartColor: string; euiFocusRingAnimStartSize: string; euiFocusRingAnimStartSizeLarge: string; euiFocusRingSizeLarge: string; euiFocusRingSize: string; euiFocusTransparency: number; euiFocusBackgroundColor: string; euiTooltipBackgroundColor: string; euiTooltipAnimations: { top: string; left: string; bottom: string; right: string; }; euiFontFamily: string; euiCodeFontFamily: string; euiFontFeatureSettings: string; euiTextScale: string; euiFontSize: string; euiFontSizeXS: string; euiFontSizeS: string; euiFontSizeM: string; euiFontSizeL: string; euiFontSizeXL: string; euiFontSizeXXL: string; euiLineHeight: number; euiBodyLineHeight: number; euiFontWeightLight: number; euiFontWeightRegular: number; euiFontWeightMedium: number; euiFontWeightSemiBold: number; euiFontWeightBold: number; euiCodeFontWeightRegular: number; euiCodeFontWeightBold: number; euiTitles: { xxxs: { 'font-size': string; 'line-height': string; 'font-weight': number; }; xxs: { 'font-size': string; 'line-height': string; 'font-weight': number; }; xs: { 'font-size': string; 'line-height': string; 'font-weight': number; 'letter-spacing': string; }; s: { 'font-size': string; 'line-height': string; 'font-weight': number; 'letter-spacing': string; }; m: { 'font-size': string; 'line-height': string; 'font-weight': number; 'letter-spacing': string; }; l: { 'font-size': string; 'line-height': string; 'font-weight': number; 'letter-spacing': string; }; }; euiZLevel0: number; euiZLevel1: number; euiZLevel2: number; euiZLevel3: number; euiZLevel4: number; euiZLevel5: number; euiZLevel6: number; euiZLevel7: number; euiZLevel8: number; euiZLevel9: number; euiZContent: number; euiZHeader: number; euiZContentMenu: number; euiZFlyout: number; euiZNavigation: number; euiZMask: number; euiZModal: number; euiZToastList: number; } | { paddingSizes: { xs: string; s: string; m: string; l: string; xl: string; }; avatarSizing: { s: { size: string; 'font-size': string; }; m: { size: string; 'font-size': string; }; l: { size: string; 'font-size': string; }; xl: { size: string; 'font-size': string; }; }; euiBadgeGroupGutterTypes: { gutterExtraSmall: string; gutterSmall: string; }; euiBreadcrumbSpacing: string; euiBreadcrumbTruncateWidth: string; euiButtonEmptyTypes: { primary: string; danger: string; disabled: string; ghost: string; text: string; success: string; warning: string; }; euiButtonIconTypes: { accent: string; danger: string; ghost: string; primary: string; subdued: string; success: string; text: string; warning: string; }; euiCallOutTypes: { primary: string; success: string; warning: string; danger: string; }; euiCardSpacing: string; euiCardBottomNodeHeight: string; euiCardSelectButtonBorders: { text: string; primary: string; success: string; danger: string; ghost: string; }; euiCardSelectButtonBackgrounds: { text: string; primary: string; success: string; danger: string; ghost: string; }; euiCardPaddingModifiers: { paddingNone: number; paddingSmall: string; paddingMedium: string; paddingLarge: string; }; euiCollapsibleNavWidth: string; euiCollapsibleNavGroupLightBackgroundColor: string; euiCollapsibleNavGroupDarkBackgroundColor: string; euiCollapsibleNavGroupDarkHighContrastColor: string; euiColorPickerValueRange0: string; euiColorPickerValueRange1: string; euiColorPickerSaturationRange0: string; euiColorPickerSaturationRange1: string; euiColorPickerIndicatorSize: string; euiColorPickerWidth: string; euiColorPaletteDisplaySizes: { sizeExtraSmall: string; sizeSmall: string; sizeMedium: string; }; euiContextMenuWidth: string; euiControlBarBackground: string; euiControlBarText: string; euiControlBarBorderColor: string; euiControlBarInitialHeight: string; euiControlBarMaxHeight: string; euiControlBarHeights: { s: string; m: string; l: string; }; euiDataGridPrefix: string; euiDataGridStyles: string; euiDataGridColumnResizerWidth: string; euiDataGridPopoverMaxHeight: string; euiDataGridCellPaddingS: string; euiDataGridCellPaddingM: string; euiDataGridCellPaddingL: string; euiDataGridVerticalBorder: string; euiDatePickerCalendarWidth: string; euiSuperDatePickerWidth: string; euiSuperDatePickerButtonWidth: string; euiDragAndDropSpacing: { s: string; m: string; l: string; }; euiExpressionColors: { subdued: string; primary: string; secondary: string; warning: string; danger: string; accent: string; }; euiFacetGutterSizes: { gutterNone: number; gutterSmall: string; gutterMedium: string; gutterLarge: string; }; gutterTypes: { gutterExtraSmall: string; gutterSmall: string; gutterMedium: string; gutterLarge: string; gutterExtraLarge: string; }; fractions: { fourths: { percentage: string; count: number; }; thirds: { percentage: string; count: number; }; halves: { percentage: string; count: number; }; single: { percentage: string; count: number; }; }; flyoutSizes: { small: { min: string; width: string; max: string; }; medium: { min: string; width: string; max: string; }; large: { min: string; width: string; max: string; }; }; euiFlyoutBorder: string; euiFlyoutPaddingModifiers: { paddingNone: number; paddingSmall: string; paddingMedium: string; paddingLarge: string; }; euiFilePickerTallHeight: string; euiRangeLevelColors: { primary: string; success: string; warning: string; danger: string; }; textareaResizing: { vertical: string; horizontal: string; both: string; none: string; }; euiHeaderLinksGutterSizes: { gutterXS: string; gutterS: string; gutterM: string; gutterL: string; }; ruleMargins: { marginXSmall: string; marginSmall: string; marginMedium: string; marginLarge: string; marginXLarge: string; marginXXLarge: string; }; euiIconLoadingOpacity: number; euiIconColors: { accent: string; danger: string; ghost: string; primary: string; secondary: string; success: string; subdued: string; text: string; warning: string; }; euiIconSizes: { small: string; medium: string; large: string; xLarge: string; xxLarge: string; }; euiKeyPadMenuSize: string; euiKeyPadMenuItemBetaBadgeSize: string; euiLinkColors: { subdued: string; primary: string; secondary: string; accent: string; warning: string; danger: string; text: string; ghost: string; }; euiListGroupItemHoverBackground: string; euiListGroupItemHoverBackgroundGhost: string; euiListGroupGutterTypes: { gutterSmall: string; gutterMedium: string; }; euiListGroupItemColorTypes: { primary: string; text: string; subdued: string; ghost: string; }; euiListGroupItemSizeTypes: { xSmall: string; small: string; medium: string; large: string; }; euiGradientStartStop: string; euiGradientMiddle: string; browserDefaultFontSize: string; euiMarkdownEditorMinHeight: string; euiPopoverArrowSize: string; euiPopoverTranslateDistance: string; euiProgressSizes: { xs: string; s: string; m: string; l: string; }; euiProgressColors: { primary: string; secondary: string; success: string; warning: string; danger: string; accent: string; subdued: string; vis0: string; vis1: string; vis2: string; vis3: string; vis4: string; vis5: string; vis6: string; vis7: string; vis8: string; vis9: string; customColor: string; }; euiResizableButtonTransitionSpeed: string; euiResizableButtonSize: string; euiSelectableListItemBorder: string; euiSelectableListItemPadding: string; euiSelectableTemplateSitewideTypes: { application: { color: string; 'font-weight': number; }; deployment: { color: string; 'font-weight': number; }; article: { color: string; 'font-weight': number; }; case: { color: string; 'font-weight': number; }; platform: { color: string; 'font-weight': number; }; }; euiSideNavEmphasizedBackgroundColor: string; euiSideNavRootTextcolor: string; euiSideNavBranchTextcolor: string; euiSideNavSelectedTextcolor: string; spacerSizes: { xs: string; s: string; m: string; l: string; xl: string; xxl: string; }; euiStepNumberSize: string; euiStepNumberSmallSize: string; euiStepNumberMargin: string; euiStepStatusColorsToFade: { warning: string; danger: string; disabled: string; incomplete: string; }; euiSuggestItemColors: { tint0: string; tint1: string; tint2: string; tint3: string; tint4: string; tint5: string; tint6: string; tint7: string; tint8: string; tint9: string; tint10: string; }; euiTableCellContentPadding: string; euiTableCellContentPaddingCompressed: string; euiTableCellCheckboxWidth: string; euiTableActionsAreaWidth: string; euiTableHoverColor: string; euiTableSelectedColor: string; euiTableHoverSelectedColor: string; euiTableActionsBorderColor: string; euiTableHoverClickableColor: string; euiTableFocusClickableColor: string; euiTabFontSize: string; euiTabFontSizeS: string; euiTabFontSizeL: string; euiTextColors: { default: string; subdued: string; secondary: string; accent: string; warning: string; danger: string; ghost: string; }; euiTextConstrainedMaxWidth: string; euiToastWidth: string; euiToastTypes: { primary: string; success: string; warning: string; danger: string; }; euiTokenGrayColor: string; euiTokenTypes: { euiColorVis0: { graphic: string; behindText: string; }; euiColorVis1: { graphic: string; behindText: string; }; euiColorVis2: { graphic: string; behindText: string; }; euiColorVis3: { graphic: string; behindText: string; }; euiColorVis4: { graphic: string; behindText: string; }; euiColorVis5: { graphic: string; behindText: string; }; euiColorVis6: { graphic: string; behindText: string; }; euiColorVis7: { graphic: string; behindText: string; }; euiColorVis8: { graphic: string; behindText: string; }; euiColorVis9: { graphic: string; behindText: string; }; gray: { graphic: string; behindText: string; }; }; euiTokenTypeKeys: string; euiAnimSlightBounce: string; euiAnimSlightResistance: string; euiAnimSpeedExtraFast: string; euiAnimSpeedFast: string; euiAnimSpeedNormal: string; euiAnimSpeedSlow: string; euiAnimSpeedExtraSlow: string; euiBorderWidthThin: string; euiBorderWidthThick: string; euiBorderColor: string; euiBorderRadius: string; euiBorderRadiusSmall: string; euiBorderThick: string; euiBorderThin: string; euiBorderEditable: string; euiButtonHeight: string; euiButtonHeightSmall: string; euiButtonHeightXSmall: string; euiButtonColorDisabled: string; euiButtonColorDisabledText: string; euiButtonColorGhostDisabled: string; euiButtonTypes: { primary: string; secondary: string; warning: string; danger: string; ghost: string; text: string; }; euiColorGhost: string; euiColorInk: string; euiColorPrimary: string; euiColorSecondary: string; euiColorAccent: string; euiColorSuccess: string; euiColorWarning: string; euiColorDanger: string; euiColorEmptyShade: string; euiColorLightestShade: string; euiColorLightShade: string; euiColorMediumShade: string; euiColorDarkShade: string; euiColorDarkestShade: string; euiColorFullShade: string; euiPageBackgroundColor: string; euiColorHighlight: string; euiTextColor: string; euiTitleColor: string; euiTextSubduedColor: string; euiColorDisabled: string; euiColorPrimaryText: string; euiColorSecondaryText: string; euiColorAccentText: string; euiColorWarningText: string; euiColorDangerText: string; euiColorDisabledText: string; euiColorSuccessText: string; euiLinkColor: string; euiPaletteColorBlind: { euiColorVis0: { graphic: string; behindText: string; }; euiColorVis1: { graphic: string; behindText: string; }; euiColorVis2: { graphic: string; behindText: string; }; euiColorVis3: { graphic: string; behindText: string; }; euiColorVis4: { graphic: string; behindText: string; }; euiColorVis5: { graphic: string; behindText: string; }; euiColorVis6: { graphic: string; behindText: string; }; euiColorVis7: { graphic: string; behindText: string; }; euiColorVis8: { graphic: string; behindText: string; }; euiColorVis9: { graphic: string; behindText: string; }; }; euiPaletteColorBlindKeys: string; euiColorVis0: string; euiColorVis1: string; euiColorVis2: string; euiColorVis3: string; euiColorVis4: string; euiColorVis5: string; euiColorVis6: string; euiColorVis7: string; euiColorVis8: string; euiColorVis9: string; euiColorVis0_behindText: string; euiColorVis1_behindText: string; euiColorVis2_behindText: string; euiColorVis3_behindText: string; euiColorVis4_behindText: string; euiColorVis5_behindText: string; euiColorVis6_behindText: string; euiColorVis7_behindText: string; euiColorVis8_behindText: string; euiColorVis9_behindText: string; euiColorChartLines: string; euiColorChartBand: string; euiCodeBlockBackgroundColor: string; euiCodeBlockColor: string; euiCodeBlockSelectedBackgroundColor: string; euiCodeBlockCommentColor: string; euiCodeBlockSelectorTagColor: string; euiCodeBlockStringColor: string; euiCodeBlockTagColor: string; euiCodeBlockNameColor: string; euiCodeBlockNumberColor: string; euiCodeBlockKeywordColor: string; euiCodeBlockFunctionTitleColor: string; euiCodeBlockTypeColor: string; euiCodeBlockAttributeColor: string; euiCodeBlockSymbolColor: string; euiCodeBlockParamsColor: string; euiCodeBlockMetaColor: string; euiCodeBlockTitleColor: string; euiCodeBlockSectionColor: string; euiCodeBlockAdditionColor: string; euiCodeBlockDeletionColor: string; euiCodeBlockSelectorClassColor: string; euiCodeBlockSelectorIdColor: string; euiFormMaxWidth: string; euiFormControlHeight: string; euiFormControlCompressedHeight: string; euiFormControlPadding: string; euiFormControlCompressedPadding: string; euiFormControlBorderRadius: number; euiFormControlCompressedBorderRadius: string; euiRadioSize: string; euiCheckBoxSize: string; euiCheckboxBorderRadius: string; euiSwitchHeight: string; euiSwitchWidth: string; euiSwitchThumbSize: string; euiSwitchIconHeight: string; euiSwitchHeightCompressed: string; euiSwitchWidthCompressed: string; euiSwitchThumbSizeCompressed: string; euiSwitchHeightMini: string; euiSwitchWidthMini: string; euiSwitchThumbSizeMini: string; euiFormBackgroundColor: string; euiFormBackgroundDisabledColor: string; euiFormBackgroundReadOnlyColor: string; euiFormBorderOpaqueColor: string; euiFormBorderColor: string; euiFormBorderDisabledColor: string; euiFormCustomControlDisabledIconColor: string; euiFormCustomControlBorderColor: string; euiFormControlDisabledColor: string; euiFormControlBoxShadow: string; euiFormInputGroupLabelBackground: string; euiFormInputGroupBorder: string; euiSwitchOffColor: string; euiFormControlLayoutGroupInputHeight: string; euiFormControlLayoutGroupInputCompressedHeight: string; euiFormControlLayoutGroupInputCompressedBorderRadius: string; euiRangeTrackColor: string; euiRangeThumbRadius: string; euiRangeThumbHeight: string; euiRangeThumbWidth: string; euiRangeThumbBorderColor: string; euiRangeTrackWidth: string; euiRangeTrackHeight: string; euiRangeTrackBorderWidth: number; euiRangeTrackBorderColor: string; euiRangeTrackRadius: string; euiRangeDisabledOpacity: number; euiRangeHighlightHeight: string; euiHeaderBackgroundColor: string; euiHeaderBorderColor: string; euiHeaderBreadcrumbColor: string; euiHeaderHeight: string; euiHeaderChildSize: string; euiHeaderHeightCompensation: string; euiPageDefaultMaxWidth: string; euiPageSidebarMinWidth: string; euiPanelPaddingModifiers: { paddingSmall: string; paddingMedium: string; paddingLarge: string; }; euiPanelBorderRadiusModifiers: { borderRadiusNone: number; borderRadiusMedium: string; }; euiPanelBackgroundColorModifiers: { transparent: string; plain: string; subdued: string; accent: string; primary: string; success: string; warning: string; danger: string; }; euiBreakpoints: { xs: number; s: string; m: string; l: string; xl: string; }; euiBreakpointKeys: string; euiShadowColor: string; euiShadowColorLarge: string; euiSize: string; euiSizeXS: string; euiSizeS: string; euiSizeM: string; euiSizeL: string; euiSizeXL: string; euiSizeXXL: string; euiButtonMinWidth: string; euiScrollBar: string; euiScrollBarCorner: string; euiFocusRingColor: string; euiFocusRingAnimStartColor: string; euiFocusRingAnimStartSize: string; euiFocusRingAnimStartSizeLarge: string; euiFocusRingSizeLarge: string; euiFocusRingSize: string; euiFocusTransparency: number; euiFocusBackgroundColor: string; euiTooltipBackgroundColor: string; euiTooltipAnimations: { top: string; left: string; bottom: string; right: string; }; euiFontFamily: string; euiCodeFontFamily: string; euiFontFeatureSettings: string; euiTextScale: string; euiFontSize: string; euiFontSizeXS: string; euiFontSizeS: string; euiFontSizeM: string; euiFontSizeL: string; euiFontSizeXL: string; euiFontSizeXXL: string; euiLineHeight: number; euiBodyLineHeight: number; euiFontWeightLight: number; euiFontWeightRegular: number; euiFontWeightMedium: number; euiFontWeightSemiBold: number; euiFontWeightBold: number; euiCodeFontWeightRegular: number; euiCodeFontWeightBold: number; euiTitles: { xxxs: { 'font-size': string; 'line-height': string; 'font-weight': number; }; xxs: { 'font-size': string; 'line-height': string; 'font-weight': number; }; xs: { 'font-size': string; 'line-height': string; 'font-weight': number; 'letter-spacing': string; }; s: { 'font-size': string; 'line-height': string; 'font-weight': number; 'letter-spacing': string; }; m: { 'font-size': string; 'line-height': string; 'font-weight': number; 'letter-spacing': string; }; l: { 'font-size': string; 'line-height': string; 'font-weight': number; 'letter-spacing': string; }; }; euiZLevel0: number; euiZLevel1: number; euiZLevel2: number; euiZLevel3: number; euiZLevel4: number; euiZLevel5: number; euiZLevel6: number; euiZLevel7: number; euiZLevel8: number; euiZLevel9: number; euiZContent: number; euiZHeader: number; euiZContentMenu: number; euiZFlyout: number; euiZNavigation: number; euiZMask: number; euiZModal: number; euiZToastList: number; }" + "{ paddingSizes: { xs: string; s: string; m: string; l: string; xl: string; }; avatarSizing: { s: { size: string; 'font-size': string; }; m: { size: string; 'font-size': string; }; l: { size: string; 'font-size': string; }; xl: { size: string; 'font-size': string; }; }; euiBadgeGroupGutterTypes: { gutterExtraSmall: string; gutterSmall: string; }; euiBreadcrumbSpacing: string; euiBreadcrumbTruncateWidth: string; euiButtonEmptyTypes: { primary: string; danger: string; disabled: string; ghost: string; text: string; success: string; warning: string; }; euiButtonIconTypes: { accent: string; danger: string; ghost: string; primary: string; subdued: string; success: string; text: string; warning: string; }; euiCallOutTypes: { primary: string; success: string; warning: string; danger: string; }; euiCardSpacing: string; euiCardBottomNodeHeight: string; euiCardSelectButtonBorders: { text: string; primary: string; success: string; danger: string; ghost: string; }; euiCardSelectButtonBackgrounds: { text: string; primary: string; success: string; danger: string; ghost: string; }; euiCardPaddingModifiers: { paddingNone: number; paddingSmall: string; paddingMedium: string; paddingLarge: string; }; euiCheckableCardPadding: string; euiCollapsibleNavWidth: string; euiCollapsibleNavGroupLightBackgroundColor: string; euiCollapsibleNavGroupDarkBackgroundColor: string; euiCollapsibleNavGroupDarkHighContrastColor: string; euiColorPickerValueRange0: string; euiColorPickerValueRange1: string; euiColorPickerSaturationRange0: string; euiColorPickerSaturationRange1: string; euiColorPickerIndicatorSize: string; euiColorPickerWidth: string; euiColorPaletteDisplaySizes: { sizeExtraSmall: string; sizeSmall: string; sizeMedium: string; }; euiContextMenuWidth: string; euiControlBarBackground: string; euiControlBarText: string; euiControlBarBorderColor: string; euiControlBarInitialHeight: string; euiControlBarMaxHeight: string; euiControlBarHeights: { s: string; m: string; l: string; }; euiDataGridPrefix: string; euiDataGridStyles: string; euiDataGridColumnResizerWidth: string; euiDataGridPopoverMaxHeight: string; euiDataGridCellPaddingS: string; euiDataGridCellPaddingM: string; euiDataGridCellPaddingL: string; euiDataGridVerticalBorder: string; euiDatePickerCalendarWidth: string; euiSuperDatePickerWidth: string; euiSuperDatePickerButtonWidth: string; euiDragAndDropSpacing: { s: string; m: string; l: string; }; euiExpressionColors: { subdued: string; primary: string; secondary: string; warning: string; danger: string; accent: string; }; euiFacetGutterSizes: { gutterNone: number; gutterSmall: string; gutterMedium: string; gutterLarge: string; }; gutterTypes: { gutterExtraSmall: string; gutterSmall: string; gutterMedium: string; gutterLarge: string; gutterExtraLarge: string; }; fractions: { fourths: { percentage: string; count: number; }; thirds: { percentage: string; count: number; }; halves: { percentage: string; count: number; }; single: { percentage: string; count: number; }; }; flyoutSizes: { small: { min: string; width: string; max: string; }; medium: { min: string; width: string; max: string; }; large: { min: string; width: string; max: string; }; }; euiFlyoutBorder: string; euiFlyoutPaddingModifiers: { paddingNone: number; paddingSmall: string; paddingMedium: string; paddingLarge: string; }; euiFilePickerTallHeight: string; euiRangeLevelColors: { primary: string; success: string; warning: string; danger: string; }; textareaResizing: { vertical: string; horizontal: string; both: string; none: string; }; euiHeaderLinksGutterSizes: { gutterXS: string; gutterS: string; gutterM: string; gutterL: string; }; ruleMargins: { marginXSmall: string; marginSmall: string; marginMedium: string; marginLarge: string; marginXLarge: string; marginXXLarge: string; }; euiIconLoadingOpacity: number; euiIconColors: { accent: string; danger: string; ghost: string; primary: string; secondary: string; success: string; subdued: string; text: string; warning: string; }; euiIconSizes: { small: string; medium: string; large: string; xLarge: string; xxLarge: string; }; euiKeyPadMenuSize: string; euiKeyPadMenuItemBetaBadgeSize: string; euiLinkColors: { subdued: string; primary: string; secondary: string; accent: string; warning: string; danger: string; text: string; ghost: string; }; euiListGroupItemHoverBackground: string; euiListGroupItemHoverBackgroundGhost: string; euiListGroupGutterTypes: { gutterSmall: string; gutterMedium: string; }; euiListGroupItemColorTypes: { primary: string; text: string; subdued: string; ghost: string; }; euiListGroupItemSizeTypes: { xSmall: string; small: string; medium: string; large: string; }; euiGradientStartStop: string; euiGradientMiddle: string; browserDefaultFontSize: string; euiMarkdownEditorMinHeight: string; euiPopoverArrowSize: string; euiPopoverTranslateDistance: string; euiProgressSizes: { xs: string; s: string; m: string; l: string; }; euiProgressColors: { primary: string; secondary: string; success: string; warning: string; danger: string; accent: string; subdued: string; vis0: string; vis1: string; vis2: string; vis3: string; vis4: string; vis5: string; vis6: string; vis7: string; vis8: string; vis9: string; customColor: string; }; euiResizableButtonTransitionSpeed: string; euiResizableButtonSize: string; euiSelectableListItemBorder: string; euiSelectableListItemPadding: string; euiSelectableTemplateSitewideTypes: { application: { color: string; 'font-weight': number; }; deployment: { color: string; 'font-weight': number; }; article: { color: string; 'font-weight': number; }; case: { color: string; 'font-weight': number; }; platform: { color: string; 'font-weight': number; }; }; euiSideNavEmphasizedBackgroundColor: string; euiSideNavRootTextcolor: string; euiSideNavBranchTextcolor: string; euiSideNavSelectedTextcolor: string; spacerSizes: { xs: string; s: string; m: string; l: string; xl: string; xxl: string; }; euiStepNumberSize: string; euiStepNumberSmallSize: string; euiStepNumberMargin: string; euiStepStatusColorsToFade: { warning: string; danger: string; disabled: string; incomplete: string; }; euiSuggestItemColors: { tint0: string; tint1: string; tint2: string; tint3: string; tint4: string; tint5: string; tint6: string; tint7: string; tint8: string; tint9: string; tint10: string; }; euiTableCellContentPadding: string; euiTableCellContentPaddingCompressed: string; euiTableCellCheckboxWidth: string; euiTableActionsAreaWidth: string; euiTableHoverColor: string; euiTableSelectedColor: string; euiTableHoverSelectedColor: string; euiTableActionsBorderColor: string; euiTableHoverClickableColor: string; euiTableFocusClickableColor: string; euiTabFontSize: string; euiTabFontSizeS: string; euiTabFontSizeL: string; euiTextColors: { default: string; subdued: string; secondary: string; accent: string; warning: string; danger: string; ghost: string; }; euiTextConstrainedMaxWidth: string; euiToastWidth: string; euiToastTypes: { primary: string; success: string; warning: string; danger: string; }; euiTokenGrayColor: string; euiTokenTypes: { euiColorVis0: { graphic: string; behindText: string; }; euiColorVis1: { graphic: string; behindText: string; }; euiColorVis2: { graphic: string; behindText: string; }; euiColorVis3: { graphic: string; behindText: string; }; euiColorVis4: { graphic: string; behindText: string; }; euiColorVis5: { graphic: string; behindText: string; }; euiColorVis6: { graphic: string; behindText: string; }; euiColorVis7: { graphic: string; behindText: string; }; euiColorVis8: { graphic: string; behindText: string; }; euiColorVis9: { graphic: string; behindText: string; }; gray: { graphic: string; behindText: string; }; }; euiTokenTypeKeys: string; euiAnimSlightBounce: string; euiAnimSlightResistance: string; euiAnimSpeedExtraFast: string; euiAnimSpeedFast: string; euiAnimSpeedNormal: string; euiAnimSpeedSlow: string; euiAnimSpeedExtraSlow: string; euiBorderWidthThin: string; euiBorderWidthThick: string; euiBorderColor: string; euiBorderRadius: string; euiBorderRadiusSmall: string; euiBorderThick: string; euiBorderThin: string; euiBorderEditable: string; euiButtonHeight: string; euiButtonHeightSmall: string; euiButtonHeightXSmall: string; euiButtonColorDisabled: string; euiButtonColorDisabledText: string; euiButtonColorGhostDisabled: string; euiButtonTypes: { primary: string; secondary: string; warning: string; danger: string; ghost: string; text: string; }; euiColorGhost: string; euiColorInk: string; euiColorPrimary: string; euiColorSecondary: string; euiColorAccent: string; euiColorSuccess: string; euiColorWarning: string; euiColorDanger: string; euiColorEmptyShade: string; euiColorLightestShade: string; euiColorLightShade: string; euiColorMediumShade: string; euiColorDarkShade: string; euiColorDarkestShade: string; euiColorFullShade: string; euiPageBackgroundColor: string; euiColorHighlight: string; euiTextColor: string; euiTitleColor: string; euiTextSubduedColor: string; euiColorDisabled: string; euiColorPrimaryText: string; euiColorSecondaryText: string; euiColorAccentText: string; euiColorWarningText: string; euiColorDangerText: string; euiColorDisabledText: string; euiColorSuccessText: string; euiLinkColor: string; euiPaletteColorBlind: { euiColorVis0: { graphic: string; behindText: string; }; euiColorVis1: { graphic: string; behindText: string; }; euiColorVis2: { graphic: string; behindText: string; }; euiColorVis3: { graphic: string; behindText: string; }; euiColorVis4: { graphic: string; behindText: string; }; euiColorVis5: { graphic: string; behindText: string; }; euiColorVis6: { graphic: string; behindText: string; }; euiColorVis7: { graphic: string; behindText: string; }; euiColorVis8: { graphic: string; behindText: string; }; euiColorVis9: { graphic: string; behindText: string; }; }; euiPaletteColorBlindKeys: string; euiColorVis0: string; euiColorVis1: string; euiColorVis2: string; euiColorVis3: string; euiColorVis4: string; euiColorVis5: string; euiColorVis6: string; euiColorVis7: string; euiColorVis8: string; euiColorVis9: string; euiColorVis0_behindText: string; euiColorVis1_behindText: string; euiColorVis2_behindText: string; euiColorVis3_behindText: string; euiColorVis4_behindText: string; euiColorVis5_behindText: string; euiColorVis6_behindText: string; euiColorVis7_behindText: string; euiColorVis8_behindText: string; euiColorVis9_behindText: string; euiColorChartLines: string; euiColorChartBand: string; euiCodeBlockBackgroundColor: string; euiCodeBlockColor: string; euiCodeBlockSelectedBackgroundColor: string; euiCodeBlockCommentColor: string; euiCodeBlockSelectorTagColor: string; euiCodeBlockStringColor: string; euiCodeBlockTagColor: string; euiCodeBlockNameColor: string; euiCodeBlockNumberColor: string; euiCodeBlockKeywordColor: string; euiCodeBlockFunctionTitleColor: string; euiCodeBlockTypeColor: string; euiCodeBlockAttributeColor: string; euiCodeBlockSymbolColor: string; euiCodeBlockParamsColor: string; euiCodeBlockMetaColor: string; euiCodeBlockTitleColor: string; euiCodeBlockSectionColor: string; euiCodeBlockAdditionColor: string; euiCodeBlockDeletionColor: string; euiCodeBlockSelectorClassColor: string; euiCodeBlockSelectorIdColor: string; euiFormMaxWidth: string; euiFormControlHeight: string; euiFormControlCompressedHeight: string; euiFormControlPadding: string; euiFormControlCompressedPadding: string; euiFormControlBorderRadius: number; euiFormControlCompressedBorderRadius: string; euiRadioSize: string; euiCheckBoxSize: string; euiCheckboxBorderRadius: string; euiSwitchHeight: string; euiSwitchWidth: string; euiSwitchThumbSize: string; euiSwitchIconHeight: string; euiSwitchHeightCompressed: string; euiSwitchWidthCompressed: string; euiSwitchThumbSizeCompressed: string; euiSwitchHeightMini: string; euiSwitchWidthMini: string; euiSwitchThumbSizeMini: string; euiFormBackgroundColor: string; euiFormBackgroundDisabledColor: string; euiFormBackgroundReadOnlyColor: string; euiFormBorderOpaqueColor: string; euiFormBorderColor: string; euiFormBorderDisabledColor: string; euiFormCustomControlDisabledIconColor: string; euiFormCustomControlBorderColor: string; euiFormControlDisabledColor: string; euiFormControlBoxShadow: string; euiFormInputGroupLabelBackground: string; euiFormInputGroupBorder: string; euiSwitchOffColor: string; euiFormControlLayoutGroupInputHeight: string; euiFormControlLayoutGroupInputCompressedHeight: string; euiFormControlLayoutGroupInputCompressedBorderRadius: string; euiRangeTrackColor: string; euiRangeThumbRadius: string; euiRangeThumbHeight: string; euiRangeThumbWidth: string; euiRangeThumbBorderColor: string; euiRangeTrackWidth: string; euiRangeTrackHeight: string; euiRangeTrackBorderWidth: number; euiRangeTrackBorderColor: string; euiRangeTrackRadius: string; euiRangeDisabledOpacity: number; euiRangeHighlightHeight: string; euiHeaderBackgroundColor: string; euiHeaderDarkBackgroundColor: string; euiHeaderBorderColor: string; euiHeaderBreadcrumbColor: string; euiHeaderHeight: string; euiHeaderChildSize: string; euiHeaderHeightCompensation: string; euiPageDefaultMaxWidth: string; euiPageSidebarMinWidth: string; euiPanelPaddingModifiers: { paddingSmall: string; paddingMedium: string; paddingLarge: string; }; euiPanelBorderRadiusModifiers: { borderRadiusNone: number; borderRadiusMedium: string; }; euiPanelBackgroundColorModifiers: { transparent: string; plain: string; subdued: string; accent: string; primary: string; success: string; warning: string; danger: string; }; euiBreakpoints: { xs: number; s: string; m: string; l: string; xl: string; }; euiBreakpointKeys: string; euiShadowColor: string; euiShadowColorLarge: string; euiSize: string; euiSizeXS: string; euiSizeS: string; euiSizeM: string; euiSizeL: string; euiSizeXL: string; euiSizeXXL: string; euiButtonMinWidth: string; euiScrollBar: string; euiScrollBarCorner: string; euiFocusRingColor: string; euiFocusRingAnimStartColor: string; euiFocusRingAnimStartSize: string; euiFocusRingAnimStartSizeLarge: string; euiFocusRingSizeLarge: string; euiFocusRingSize: string; euiFocusTransparency: number; euiFocusBackgroundColor: string; euiTooltipBackgroundColor: string; euiTooltipAnimations: { top: string; left: string; bottom: string; right: string; }; euiFontFamily: string; euiCodeFontFamily: string; euiFontFeatureSettings: string; euiTextScale: string; euiFontSize: string; euiFontSizeXS: string; euiFontSizeS: string; euiFontSizeM: string; euiFontSizeL: string; euiFontSizeXL: string; euiFontSizeXXL: string; euiLineHeight: number; euiBodyLineHeight: number; euiFontWeightLight: number; euiFontWeightRegular: number; euiFontWeightMedium: number; euiFontWeightSemiBold: number; euiFontWeightBold: number; euiCodeFontWeightRegular: number; euiCodeFontWeightBold: number; euiTitles: { xxxs: { 'font-size': string; 'line-height': string; 'font-weight': number; }; xxs: { 'font-size': string; 'line-height': string; 'font-weight': number; }; xs: { 'font-size': string; 'line-height': string; 'font-weight': number; 'letter-spacing': string; }; s: { 'font-size': string; 'line-height': string; 'font-weight': number; 'letter-spacing': string; }; m: { 'font-size': string; 'line-height': string; 'font-weight': number; 'letter-spacing': string; }; l: { 'font-size': string; 'line-height': string; 'font-weight': number; 'letter-spacing': string; }; }; euiZLevel0: number; euiZLevel1: number; euiZLevel2: number; euiZLevel3: number; euiZLevel4: number; euiZLevel5: number; euiZLevel6: number; euiZLevel7: number; euiZLevel8: number; euiZLevel9: number; euiZContent: number; euiZHeader: number; euiZContentMenu: number; euiZFlyout: number; euiZNavigation: number; euiZMask: number; euiZModal: number; euiZToastList: number; } | { paddingSizes: { xs: string; s: string; m: string; l: string; xl: string; }; avatarSizing: { s: { size: string; 'font-size': string; }; m: { size: string; 'font-size': string; }; l: { size: string; 'font-size': string; }; xl: { size: string; 'font-size': string; }; }; euiBadgeGroupGutterTypes: { gutterExtraSmall: string; gutterSmall: string; }; euiBreadcrumbSpacing: string; euiBreadcrumbTruncateWidth: string; euiButtonEmptyTypes: { primary: string; danger: string; disabled: string; ghost: string; text: string; success: string; warning: string; }; euiButtonIconTypes: { accent: string; danger: string; ghost: string; primary: string; subdued: string; success: string; text: string; warning: string; }; euiCallOutTypes: { primary: string; success: string; warning: string; danger: string; }; euiCardSpacing: string; euiCardBottomNodeHeight: string; euiCardSelectButtonBorders: { text: string; primary: string; success: string; danger: string; ghost: string; }; euiCardSelectButtonBackgrounds: { text: string; primary: string; success: string; danger: string; ghost: string; }; euiCardPaddingModifiers: { paddingNone: number; paddingSmall: string; paddingMedium: string; paddingLarge: string; }; euiCheckableCardPadding: string; euiCollapsibleNavWidth: string; euiCollapsibleNavGroupLightBackgroundColor: string; euiCollapsibleNavGroupDarkBackgroundColor: string; euiCollapsibleNavGroupDarkHighContrastColor: string; euiColorPickerValueRange0: string; euiColorPickerValueRange1: string; euiColorPickerSaturationRange0: string; euiColorPickerSaturationRange1: string; euiColorPickerIndicatorSize: string; euiColorPickerWidth: string; euiColorPaletteDisplaySizes: { sizeExtraSmall: string; sizeSmall: string; sizeMedium: string; }; euiContextMenuWidth: string; euiControlBarBackground: string; euiControlBarText: string; euiControlBarBorderColor: string; euiControlBarInitialHeight: string; euiControlBarMaxHeight: string; euiControlBarHeights: { s: string; m: string; l: string; }; euiDataGridPrefix: string; euiDataGridStyles: string; euiDataGridColumnResizerWidth: string; euiDataGridPopoverMaxHeight: string; euiDataGridCellPaddingS: string; euiDataGridCellPaddingM: string; euiDataGridCellPaddingL: string; euiDataGridVerticalBorder: string; euiDatePickerCalendarWidth: string; euiSuperDatePickerWidth: string; euiSuperDatePickerButtonWidth: string; euiDragAndDropSpacing: { s: string; m: string; l: string; }; euiExpressionColors: { subdued: string; primary: string; secondary: string; warning: string; danger: string; accent: string; }; euiFacetGutterSizes: { gutterNone: number; gutterSmall: string; gutterMedium: string; gutterLarge: string; }; gutterTypes: { gutterExtraSmall: string; gutterSmall: string; gutterMedium: string; gutterLarge: string; gutterExtraLarge: string; }; fractions: { fourths: { percentage: string; count: number; }; thirds: { percentage: string; count: number; }; halves: { percentage: string; count: number; }; single: { percentage: string; count: number; }; }; flyoutSizes: { small: { min: string; width: string; max: string; }; medium: { min: string; width: string; max: string; }; large: { min: string; width: string; max: string; }; }; euiFlyoutBorder: string; euiFlyoutPaddingModifiers: { paddingNone: number; paddingSmall: string; paddingMedium: string; paddingLarge: string; }; euiFilePickerTallHeight: string; euiRangeLevelColors: { primary: string; success: string; warning: string; danger: string; }; textareaResizing: { vertical: string; horizontal: string; both: string; none: string; }; euiHeaderLinksGutterSizes: { gutterXS: string; gutterS: string; gutterM: string; gutterL: string; }; ruleMargins: { marginXSmall: string; marginSmall: string; marginMedium: string; marginLarge: string; marginXLarge: string; marginXXLarge: string; }; euiIconLoadingOpacity: number; euiIconColors: { accent: string; danger: string; ghost: string; primary: string; secondary: string; success: string; subdued: string; text: string; warning: string; }; euiIconSizes: { small: string; medium: string; large: string; xLarge: string; xxLarge: string; }; euiKeyPadMenuSize: string; euiKeyPadMenuItemBetaBadgeSize: string; euiLinkColors: { subdued: string; primary: string; secondary: string; accent: string; warning: string; danger: string; text: string; ghost: string; }; euiListGroupItemHoverBackground: string; euiListGroupItemHoverBackgroundGhost: string; euiListGroupGutterTypes: { gutterSmall: string; gutterMedium: string; }; euiListGroupItemColorTypes: { primary: string; text: string; subdued: string; ghost: string; }; euiListGroupItemSizeTypes: { xSmall: string; small: string; medium: string; large: string; }; euiGradientStartStop: string; euiGradientMiddle: string; browserDefaultFontSize: string; euiMarkdownEditorMinHeight: string; euiPopoverArrowSize: string; euiPopoverTranslateDistance: string; euiProgressSizes: { xs: string; s: string; m: string; l: string; }; euiProgressColors: { primary: string; secondary: string; success: string; warning: string; danger: string; accent: string; subdued: string; vis0: string; vis1: string; vis2: string; vis3: string; vis4: string; vis5: string; vis6: string; vis7: string; vis8: string; vis9: string; customColor: string; }; euiResizableButtonTransitionSpeed: string; euiResizableButtonSize: string; euiSelectableListItemBorder: string; euiSelectableListItemPadding: string; euiSelectableTemplateSitewideTypes: { application: { color: string; 'font-weight': number; }; deployment: { color: string; 'font-weight': number; }; article: { color: string; 'font-weight': number; }; case: { color: string; 'font-weight': number; }; platform: { color: string; 'font-weight': number; }; }; euiSideNavEmphasizedBackgroundColor: string; euiSideNavRootTextcolor: string; euiSideNavBranchTextcolor: string; euiSideNavSelectedTextcolor: string; spacerSizes: { xs: string; s: string; m: string; l: string; xl: string; xxl: string; }; euiStepNumberSize: string; euiStepNumberSmallSize: string; euiStepNumberMargin: string; euiStepStatusColorsToFade: { warning: string; danger: string; disabled: string; incomplete: string; }; euiSuggestItemColors: { tint0: string; tint1: string; tint2: string; tint3: string; tint4: string; tint5: string; tint6: string; tint7: string; tint8: string; tint9: string; tint10: string; }; euiTableCellContentPadding: string; euiTableCellContentPaddingCompressed: string; euiTableCellCheckboxWidth: string; euiTableActionsAreaWidth: string; euiTableHoverColor: string; euiTableSelectedColor: string; euiTableHoverSelectedColor: string; euiTableActionsBorderColor: string; euiTableHoverClickableColor: string; euiTableFocusClickableColor: string; euiTabFontSize: string; euiTabFontSizeS: string; euiTabFontSizeL: string; euiTextColors: { default: string; subdued: string; secondary: string; accent: string; warning: string; danger: string; ghost: string; }; euiTextConstrainedMaxWidth: string; euiToastWidth: string; euiToastTypes: { primary: string; success: string; warning: string; danger: string; }; euiTokenGrayColor: string; euiTokenTypes: { euiColorVis0: { graphic: string; behindText: string; }; euiColorVis1: { graphic: string; behindText: string; }; euiColorVis2: { graphic: string; behindText: string; }; euiColorVis3: { graphic: string; behindText: string; }; euiColorVis4: { graphic: string; behindText: string; }; euiColorVis5: { graphic: string; behindText: string; }; euiColorVis6: { graphic: string; behindText: string; }; euiColorVis7: { graphic: string; behindText: string; }; euiColorVis8: { graphic: string; behindText: string; }; euiColorVis9: { graphic: string; behindText: string; }; gray: { graphic: string; behindText: string; }; }; euiTokenTypeKeys: string; euiAnimSlightBounce: string; euiAnimSlightResistance: string; euiAnimSpeedExtraFast: string; euiAnimSpeedFast: string; euiAnimSpeedNormal: string; euiAnimSpeedSlow: string; euiAnimSpeedExtraSlow: string; euiBorderWidthThin: string; euiBorderWidthThick: string; euiBorderColor: string; euiBorderRadius: string; euiBorderRadiusSmall: string; euiBorderThick: string; euiBorderThin: string; euiBorderEditable: string; euiButtonHeight: string; euiButtonHeightSmall: string; euiButtonHeightXSmall: string; euiButtonColorDisabled: string; euiButtonColorDisabledText: string; euiButtonColorGhostDisabled: string; euiButtonTypes: { primary: string; secondary: string; warning: string; danger: string; ghost: string; text: string; }; euiColorGhost: string; euiColorInk: string; euiColorPrimary: string; euiColorSecondary: string; euiColorAccent: string; euiColorSuccess: string; euiColorWarning: string; euiColorDanger: string; euiColorEmptyShade: string; euiColorLightestShade: string; euiColorLightShade: string; euiColorMediumShade: string; euiColorDarkShade: string; euiColorDarkestShade: string; euiColorFullShade: string; euiPageBackgroundColor: string; euiColorHighlight: string; euiTextColor: string; euiTitleColor: string; euiTextSubduedColor: string; euiColorDisabled: string; euiColorPrimaryText: string; euiColorSecondaryText: string; euiColorAccentText: string; euiColorWarningText: string; euiColorDangerText: string; euiColorDisabledText: string; euiColorSuccessText: string; euiLinkColor: string; euiPaletteColorBlind: { euiColorVis0: { graphic: string; behindText: string; }; euiColorVis1: { graphic: string; behindText: string; }; euiColorVis2: { graphic: string; behindText: string; }; euiColorVis3: { graphic: string; behindText: string; }; euiColorVis4: { graphic: string; behindText: string; }; euiColorVis5: { graphic: string; behindText: string; }; euiColorVis6: { graphic: string; behindText: string; }; euiColorVis7: { graphic: string; behindText: string; }; euiColorVis8: { graphic: string; behindText: string; }; euiColorVis9: { graphic: string; behindText: string; }; }; euiPaletteColorBlindKeys: string; euiColorVis0: string; euiColorVis1: string; euiColorVis2: string; euiColorVis3: string; euiColorVis4: string; euiColorVis5: string; euiColorVis6: string; euiColorVis7: string; euiColorVis8: string; euiColorVis9: string; euiColorVis0_behindText: string; euiColorVis1_behindText: string; euiColorVis2_behindText: string; euiColorVis3_behindText: string; euiColorVis4_behindText: string; euiColorVis5_behindText: string; euiColorVis6_behindText: string; euiColorVis7_behindText: string; euiColorVis8_behindText: string; euiColorVis9_behindText: string; euiColorChartLines: string; euiColorChartBand: string; euiCodeBlockBackgroundColor: string; euiCodeBlockColor: string; euiCodeBlockSelectedBackgroundColor: string; euiCodeBlockCommentColor: string; euiCodeBlockSelectorTagColor: string; euiCodeBlockStringColor: string; euiCodeBlockTagColor: string; euiCodeBlockNameColor: string; euiCodeBlockNumberColor: string; euiCodeBlockKeywordColor: string; euiCodeBlockFunctionTitleColor: string; euiCodeBlockTypeColor: string; euiCodeBlockAttributeColor: string; euiCodeBlockSymbolColor: string; euiCodeBlockParamsColor: string; euiCodeBlockMetaColor: string; euiCodeBlockTitleColor: string; euiCodeBlockSectionColor: string; euiCodeBlockAdditionColor: string; euiCodeBlockDeletionColor: string; euiCodeBlockSelectorClassColor: string; euiCodeBlockSelectorIdColor: string; euiFormMaxWidth: string; euiFormControlHeight: string; euiFormControlCompressedHeight: string; euiFormControlPadding: string; euiFormControlCompressedPadding: string; euiFormControlBorderRadius: number; euiFormControlCompressedBorderRadius: string; euiRadioSize: string; euiCheckBoxSize: string; euiCheckboxBorderRadius: string; euiSwitchHeight: string; euiSwitchWidth: string; euiSwitchThumbSize: string; euiSwitchIconHeight: string; euiSwitchHeightCompressed: string; euiSwitchWidthCompressed: string; euiSwitchThumbSizeCompressed: string; euiSwitchHeightMini: string; euiSwitchWidthMini: string; euiSwitchThumbSizeMini: string; euiFormBackgroundColor: string; euiFormBackgroundDisabledColor: string; euiFormBackgroundReadOnlyColor: string; euiFormBorderOpaqueColor: string; euiFormBorderColor: string; euiFormBorderDisabledColor: string; euiFormCustomControlDisabledIconColor: string; euiFormCustomControlBorderColor: string; euiFormControlDisabledColor: string; euiFormControlBoxShadow: string; euiFormInputGroupLabelBackground: string; euiFormInputGroupBorder: string; euiSwitchOffColor: string; euiFormControlLayoutGroupInputHeight: string; euiFormControlLayoutGroupInputCompressedHeight: string; euiFormControlLayoutGroupInputCompressedBorderRadius: string; euiRangeTrackColor: string; euiRangeThumbRadius: string; euiRangeThumbHeight: string; euiRangeThumbWidth: string; euiRangeThumbBorderColor: string; euiRangeTrackWidth: string; euiRangeTrackHeight: string; euiRangeTrackBorderWidth: number; euiRangeTrackBorderColor: string; euiRangeTrackRadius: string; euiRangeDisabledOpacity: number; euiRangeHighlightHeight: string; euiHeaderBackgroundColor: string; euiHeaderDarkBackgroundColor: string; euiHeaderBorderColor: string; euiHeaderBreadcrumbColor: string; euiHeaderHeight: string; euiHeaderChildSize: string; euiHeaderHeightCompensation: string; euiPageDefaultMaxWidth: string; euiPageSidebarMinWidth: string; euiPanelPaddingModifiers: { paddingSmall: string; paddingMedium: string; paddingLarge: string; }; euiPanelBorderRadiusModifiers: { borderRadiusNone: number; borderRadiusMedium: string; }; euiPanelBackgroundColorModifiers: { transparent: string; plain: string; subdued: string; accent: string; primary: string; success: string; warning: string; danger: string; }; euiBreakpoints: { xs: number; s: string; m: string; l: string; xl: string; }; euiBreakpointKeys: string; euiShadowColor: string; euiShadowColorLarge: string; euiSize: string; euiSizeXS: string; euiSizeS: string; euiSizeM: string; euiSizeL: string; euiSizeXL: string; euiSizeXXL: string; euiButtonMinWidth: string; euiScrollBar: string; euiScrollBarCorner: string; euiFocusRingColor: string; euiFocusRingAnimStartColor: string; euiFocusRingAnimStartSize: string; euiFocusRingAnimStartSizeLarge: string; euiFocusRingSizeLarge: string; euiFocusRingSize: string; euiFocusTransparency: number; euiFocusBackgroundColor: string; euiTooltipBackgroundColor: string; euiTooltipAnimations: { top: string; left: string; bottom: string; right: string; }; euiFontFamily: string; euiCodeFontFamily: string; euiFontFeatureSettings: string; euiTextScale: string; euiFontSize: string; euiFontSizeXS: string; euiFontSizeS: string; euiFontSizeM: string; euiFontSizeL: string; euiFontSizeXL: string; euiFontSizeXXL: string; euiLineHeight: number; euiBodyLineHeight: number; euiFontWeightLight: number; euiFontWeightRegular: number; euiFontWeightMedium: number; euiFontWeightSemiBold: number; euiFontWeightBold: number; euiCodeFontWeightRegular: number; euiCodeFontWeightBold: number; euiTitles: { xxxs: { 'font-size': string; 'line-height': string; 'font-weight': number; }; xxs: { 'font-size': string; 'line-height': string; 'font-weight': number; }; xs: { 'font-size': string; 'line-height': string; 'font-weight': number; 'letter-spacing': string; }; s: { 'font-size': string; 'line-height': string; 'font-weight': number; 'letter-spacing': string; }; m: { 'font-size': string; 'line-height': string; 'font-weight': number; 'letter-spacing': string; }; l: { 'font-size': string; 'line-height': string; 'font-weight': number; 'letter-spacing': string; }; }; euiZLevel0: number; euiZLevel1: number; euiZLevel2: number; euiZLevel3: number; euiZLevel4: number; euiZLevel5: number; euiZLevel6: number; euiZLevel7: number; euiZLevel8: number; euiZLevel9: number; euiZContent: number; euiZHeader: number; euiZContentMenu: number; euiZFlyout: number; euiZNavigation: number; euiZMask: number; euiZModal: number; euiZToastList: number; }" ] }, { diff --git a/api_docs/lens.json b/api_docs/lens.json index 8176ea2dfb7a0..a503bf5d01c38 100644 --- a/api_docs/lens.json +++ b/api_docs/lens.json @@ -66,7 +66,13 @@ " extends ", "FormattedIndexPatternColumn", ",", - "FieldBasedIndexPatternColumn" + { + "pluginId": "lens", + "scope": "public", + "docId": "kibLensPluginApi", + "section": "def-public.FieldBasedIndexPatternColumn", + "text": "FieldBasedIndexPatternColumn" + } ], "description": [], "tags": [], @@ -160,7 +166,13 @@ "text": "DateHistogramIndexPatternColumn" }, " extends ", - "FieldBasedIndexPatternColumn" + { + "pluginId": "lens", + "scope": "public", + "docId": "kibLensPluginApi", + "section": "def-public.FieldBasedIndexPatternColumn", + "text": "FieldBasedIndexPatternColumn" + } ], "description": [], "tags": [], @@ -312,7 +324,7 @@ "description": [], "source": { "path": "x-pack/plugins/lens/public/indexpattern_datasource/types.ts", - "lineNumber": 73 + "lineNumber": 74 }, "signature": [ "Record void" + ", openInNewTab?: boolean | undefined) => void" ] }, { @@ -503,7 +521,7 @@ ], "source": { "path": "x-pack/plugins/lens/public/plugin.ts", - "lineNumber": 103 + "lineNumber": 105 }, "signature": [ "() => boolean" @@ -519,7 +537,7 @@ ], "source": { "path": "x-pack/plugins/lens/public/plugin.ts", - "lineNumber": 108 + "lineNumber": 110 }, "signature": [ "() => Promise<", @@ -530,7 +548,7 @@ ], "source": { "path": "x-pack/plugins/lens/public/plugin.ts", - "lineNumber": 81 + "lineNumber": 83 }, "initialIsOpen": false }, @@ -647,7 +665,13 @@ "text": "PercentileIndexPatternColumn" }, " extends ", - "FieldBasedIndexPatternColumn" + { + "pluginId": "lens", + "scope": "public", + "docId": "kibLensPluginApi", + "section": "def-public.FieldBasedIndexPatternColumn", + "text": "FieldBasedIndexPatternColumn" + } ], "description": [], "tags": [], @@ -770,7 +794,13 @@ "text": "RangeIndexPatternColumn" }, " extends ", - "FieldBasedIndexPatternColumn" + { + "pluginId": "lens", + "scope": "public", + "docId": "kibLensPluginApi", + "section": "def-public.FieldBasedIndexPatternColumn", + "text": "FieldBasedIndexPatternColumn" + } ], "description": [], "tags": [], @@ -953,7 +983,13 @@ "text": "TermsIndexPatternColumn" }, " extends ", - "FieldBasedIndexPatternColumn" + { + "pluginId": "lens", + "scope": "public", + "docId": "kibLensPluginApi", + "section": "def-public.FieldBasedIndexPatternColumn", + "text": "FieldBasedIndexPatternColumn" + } ], "description": [], "tags": [], @@ -983,7 +1019,7 @@ "lineNumber": 58 }, "signature": [ - "{ size: number; orderBy: { type: \"alphabetical\"; } | { type: \"column\"; columnId: string; }; orderDirection: \"asc\" | \"desc\"; otherBucket?: boolean | undefined; missingBucket?: boolean | undefined; format?: { id: string; params?: { decimals: number; } | undefined; } | undefined; }" + "{ size: number; orderBy: { type: \"alphabetical\"; fallback?: boolean | undefined; } | { type: \"column\"; columnId: string; }; orderDirection: \"asc\" | \"desc\"; otherBucket?: boolean | undefined; missingBucket?: boolean | undefined; format?: { id: string; params?: { decimals: number; } | undefined; } | undefined; }" ] } ], @@ -1145,7 +1181,7 @@ "description": [], "source": { "path": "x-pack/plugins/lens/public/xy_visualization/types.ts", - "lineNumber": 423 + "lineNumber": 424 }, "signature": [ { @@ -1165,7 +1201,7 @@ "description": [], "source": { "path": "x-pack/plugins/lens/public/xy_visualization/types.ts", - "lineNumber": 424 + "lineNumber": 425 }, "signature": [ { @@ -1185,7 +1221,7 @@ "description": [], "source": { "path": "x-pack/plugins/lens/public/xy_visualization/types.ts", - "lineNumber": 425 + "lineNumber": 426 }, "signature": [ "\"hide\" | \"inside\" | \"outside\" | undefined" @@ -1199,7 +1235,7 @@ "description": [], "source": { "path": "x-pack/plugins/lens/public/xy_visualization/types.ts", - "lineNumber": 426 + "lineNumber": 427 }, "signature": [ "\"None\" | \"Zero\" | \"Linear\" | \"Carry\" | \"Lookahead\" | undefined" @@ -1213,7 +1249,7 @@ "description": [], "source": { "path": "x-pack/plugins/lens/public/xy_visualization/types.ts", - "lineNumber": 427 + "lineNumber": 428 }, "signature": [ { @@ -1234,7 +1270,7 @@ "description": [], "source": { "path": "x-pack/plugins/lens/public/xy_visualization/types.ts", - "lineNumber": 428 + "lineNumber": 429 }, "signature": [ "string | undefined" @@ -1248,7 +1284,7 @@ "description": [], "source": { "path": "x-pack/plugins/lens/public/xy_visualization/types.ts", - "lineNumber": 429 + "lineNumber": 430 }, "signature": [ "string | undefined" @@ -1262,7 +1298,7 @@ "description": [], "source": { "path": "x-pack/plugins/lens/public/xy_visualization/types.ts", - "lineNumber": 430 + "lineNumber": 431 }, "signature": [ "string | undefined" @@ -1276,7 +1312,7 @@ "description": [], "source": { "path": "x-pack/plugins/lens/public/xy_visualization/types.ts", - "lineNumber": 431 + "lineNumber": 432 }, "signature": [ { @@ -1297,7 +1333,7 @@ "description": [], "source": { "path": "x-pack/plugins/lens/public/xy_visualization/types.ts", - "lineNumber": 432 + "lineNumber": 433 }, "signature": [ { @@ -1318,7 +1354,7 @@ "description": [], "source": { "path": "x-pack/plugins/lens/public/xy_visualization/types.ts", - "lineNumber": 433 + "lineNumber": 434 }, "signature": [ { @@ -1339,16 +1375,30 @@ "description": [], "source": { "path": "x-pack/plugins/lens/public/xy_visualization/types.ts", - "lineNumber": 434 + "lineNumber": 435 }, "signature": [ "\"LINEAR\" | \"CURVE_MONOTONE_X\" | undefined" ] + }, + { + "tags": [], + "id": "def-public.XYState.hideEndzones", + "type": "CompoundType", + "label": "hideEndzones", + "description": [], + "source": { + "path": "x-pack/plugins/lens/public/xy_visualization/types.ts", + "lineNumber": 436 + }, + "signature": [ + "boolean | undefined" + ] } ], "source": { "path": "x-pack/plugins/lens/public/xy_visualization/types.ts", - "lineNumber": 422 + "lineNumber": 423 }, "initialIsOpen": false } @@ -1472,6 +1522,59 @@ ], "initialIsOpen": false }, + { + "id": "def-public.FieldBasedIndexPatternColumn", + "type": "Type", + "label": "FieldBasedIndexPatternColumn", + "tags": [], + "description": [], + "source": { + "path": "x-pack/plugins/lens/public/indexpattern_datasource/operations/definitions/index.ts", + "lineNumber": 71 + }, + "signature": [ + { + "pluginId": "lens", + "scope": "public", + "docId": "kibLensPluginApi", + "section": "def-public.RangeIndexPatternColumn", + "text": "RangeIndexPatternColumn" + }, + " | ", + { + "pluginId": "lens", + "scope": "public", + "docId": "kibLensPluginApi", + "section": "def-public.TermsIndexPatternColumn", + "text": "TermsIndexPatternColumn" + }, + " | ", + { + "pluginId": "lens", + "scope": "public", + "docId": "kibLensPluginApi", + "section": "def-public.DateHistogramIndexPatternColumn", + "text": "DateHistogramIndexPatternColumn" + }, + " | MetricColumn<\"min\"> | MetricColumn<\"max\"> | MetricColumn<\"average\"> | ", + { + "pluginId": "lens", + "scope": "public", + "docId": "kibLensPluginApi", + "section": "def-public.CardinalityIndexPatternColumn", + "text": "CardinalityIndexPatternColumn" + }, + " | MetricColumn<\"sum\"> | MetricColumn<\"median\"> | ", + { + "pluginId": "lens", + "scope": "public", + "docId": "kibLensPluginApi", + "section": "def-public.PercentileIndexPatternColumn", + "text": "PercentileIndexPatternColumn" + } + ], + "initialIsOpen": false + }, { "id": "def-public.IndexPatternColumn", "type": "Type", @@ -1613,7 +1716,7 @@ "description": [], "source": { "path": "x-pack/plugins/lens/public/indexpattern_datasource/types.ts", - "lineNumber": 76 + "lineNumber": 77 }, "signature": [ "{ columns: Record; columnOrder: string[]; incompleteColumns?: Record | undefined; }" @@ -1705,7 +1808,7 @@ "description": [], "source": { "path": "x-pack/plugins/lens/public/xy_visualization/types.ts", - "lineNumber": 419 + "lineNumber": 420 }, "signature": [ "\"LINEAR\" | \"CURVE_MONOTONE_X\"" @@ -2002,9 +2105,14 @@ "lineNumber": 22 }, "signature": [ - "Pick<", - "CollectorSet", - ", \"makeStatsCollector\" | \"makeUsageCollector\" | \"registerCollector\" | \"getCollectorByType\" | \"areAllCollectorsReady\" | \"bulkFetch\" | \"bulkFetchUsage\" | \"toObject\" | \"toApiFieldNames\"> | undefined" + { + "pluginId": "usageCollection", + "scope": "server", + "docId": "kibUsageCollectionPluginApi", + "section": "def-server.UsageCollectionSetup", + "text": "UsageCollectionSetup" + }, + " | undefined" ] }, { @@ -2111,7 +2219,7 @@ "returnComment": [], "source": { "path": "x-pack/plugins/lens/common/constants.ts", - "lineNumber": 16 + "lineNumber": 19 }, "initialIsOpen": false }, @@ -2120,7 +2228,15 @@ "type": "Function", "label": "getEditPath", "signature": [ - "(id: string | undefined) => string" + "(id: string | undefined, timeRange: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataQueryPluginApi", + "section": "def-common.TimeRange", + "text": "TimeRange" + }, + " | undefined) => string" ], "description": [], "children": [ @@ -2135,7 +2251,28 @@ "description": [], "source": { "path": "x-pack/plugins/lens/common/constants.ts", - "lineNumber": 20 + "lineNumber": 25 + } + }, + { + "id": "def-common.getEditPath.$2", + "type": "Object", + "label": "timeRange", + "isRequired": false, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataQueryPluginApi", + "section": "def-common.TimeRange", + "text": "TimeRange" + }, + " | undefined" + ], + "description": [], + "source": { + "path": "x-pack/plugins/lens/common/constants.ts", + "lineNumber": 25 } } ], @@ -2143,7 +2280,7 @@ "returnComment": [], "source": { "path": "x-pack/plugins/lens/common/constants.ts", - "lineNumber": 20 + "lineNumber": 25 }, "initialIsOpen": false }, @@ -2167,7 +2304,7 @@ "description": [], "source": { "path": "x-pack/plugins/lens/common/constants.ts", - "lineNumber": 24 + "lineNumber": 37 } } ], @@ -2175,7 +2312,7 @@ "returnComment": [], "source": { "path": "x-pack/plugins/lens/common/constants.ts", - "lineNumber": 24 + "lineNumber": 37 }, "initialIsOpen": false } @@ -2622,7 +2759,7 @@ "description": [], "source": { "path": "x-pack/plugins/lens/common/constants.ts", - "lineNumber": 9 + "lineNumber": 12 }, "signature": [ "\"lens\"" @@ -2637,7 +2774,7 @@ "description": [], "source": { "path": "x-pack/plugins/lens/common/constants.ts", - "lineNumber": 13 + "lineNumber": 16 }, "signature": [ "\"/api/lens\"" @@ -2652,7 +2789,7 @@ "description": [], "source": { "path": "x-pack/plugins/lens/common/constants.ts", - "lineNumber": 11 + "lineNumber": 14 }, "signature": [ "\"lens\"" @@ -2667,7 +2804,7 @@ "description": [], "source": { "path": "x-pack/plugins/lens/common/constants.ts", - "lineNumber": 14 + "lineNumber": 17 }, "signature": [ "\"edit_by_value\"" @@ -2682,7 +2819,7 @@ "description": [], "source": { "path": "x-pack/plugins/lens/common/constants.ts", - "lineNumber": 10 + "lineNumber": 13 }, "signature": [ "\"lens\"" @@ -2697,7 +2834,7 @@ "description": [], "source": { "path": "x-pack/plugins/lens/common/constants.ts", - "lineNumber": 12 + "lineNumber": 15 }, "signature": [ "\"Lens Visualizations\"" @@ -2712,7 +2849,7 @@ "description": [], "source": { "path": "x-pack/plugins/lens/common/constants.ts", - "lineNumber": 8 + "lineNumber": 11 }, "signature": [ "\"lens\"" diff --git a/api_docs/license_api_guard.json b/api_docs/license_api_guard.json new file mode 100644 index 0000000000000..c797e980806cf --- /dev/null +++ b/api_docs/license_api_guard.json @@ -0,0 +1,199 @@ +{ + "id": "licenseApiGuard", + "client": { + "classes": [], + "functions": [], + "interfaces": [], + "enums": [], + "misc": [], + "objects": [] + }, + "server": { + "classes": [ + { + "id": "def-server.License", + "type": "Class", + "tags": [], + "label": "License", + "description": [], + "children": [ + { + "id": "def-server.License.setup", + "type": "Function", + "label": "setup", + "signature": [ + "({ pluginName, logger }: SetupSettings) => void" + ], + "description": [], + "children": [ + { + "id": "def-server.License.setup.$1", + "type": "Object", + "label": "{ pluginName, logger }", + "isRequired": true, + "signature": [ + "SetupSettings" + ], + "description": [], + "source": { + "path": "x-pack/plugins/license_api_guard/server/license.ts", + "lineNumber": 41 + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "x-pack/plugins/license_api_guard/server/license.ts", + "lineNumber": 41 + } + }, + { + "id": "def-server.License.start", + "type": "Function", + "label": "start", + "signature": [ + "({ pluginId, minimumLicenseType, licensing }: StartSettings) => void" + ], + "description": [], + "children": [ + { + "id": "def-server.License.start.$1", + "type": "Object", + "label": "{ pluginId, minimumLicenseType, licensing }", + "isRequired": true, + "signature": [ + "StartSettings" + ], + "description": [], + "source": { + "path": "x-pack/plugins/license_api_guard/server/license.ts", + "lineNumber": 46 + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "x-pack/plugins/license_api_guard/server/license.ts", + "lineNumber": 46 + } + }, + { + "id": "def-server.License.guardApiRoute", + "type": "Function", + "label": "guardApiRoute", + "signature": [ + "(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" + ], + "description": [], + "children": [ + { + "id": "def-server.License.guardApiRoute.$1", + "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", + "; badRequest: (options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ErrorHttpResponseOptions", + "text": "ErrorHttpResponseOptions" + } + ], + "description": [], + "source": { + "path": "x-pack/plugins/license_api_guard/server/license.ts", + "lineNumber": 93 + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "x-pack/plugins/license_api_guard/server/license.ts", + "lineNumber": 92 + } + }, + { + "id": "def-server.License.isEsSecurityEnabled", + "type": "boolean", + "label": "isEsSecurityEnabled", + "tags": [], + "description": [], + "source": { + "path": "x-pack/plugins/license_api_guard/server/license.ts", + "lineNumber": 116 + } + } + ], + "source": { + "path": "x-pack/plugins/license_api_guard/server/license.ts", + "lineNumber": 33 + }, + "initialIsOpen": false + } + ], + "functions": [], + "interfaces": [], + "enums": [], + "misc": [], + "objects": [] + }, + "common": { + "classes": [], + "functions": [], + "interfaces": [], + "enums": [], + "misc": [], + "objects": [] + } +} \ No newline at end of file diff --git a/api_docs/license_api_guard.mdx b/api_docs/license_api_guard.mdx new file mode 100644 index 0000000000000..d11b92e9bbc14 --- /dev/null +++ b/api_docs/license_api_guard.mdx @@ -0,0 +1,18 @@ +--- +id: kibLicenseApiGuardPluginApi +slug: /kibana-dev-docs/licenseApiGuardPluginApi +title: licenseApiGuard +image: https://source.unsplash.com/400x175/?github +summary: API docs for the licenseApiGuard plugin +date: 2020-11-16 +tags: ['contributor', 'dev', 'apidocs', 'kibana', 'licenseApiGuard'] +warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. +--- + +import licenseApiGuardObj from './license_api_guard.json'; + +## Server + +### Classes + + diff --git a/api_docs/licensing.json b/api_docs/licensing.json index df2511925bd61..a5f3ebc64d489 100644 --- a/api_docs/licensing.json +++ b/api_docs/licensing.json @@ -580,7 +580,7 @@ "lineNumber": 8 }, "signature": [ - "\"valid\" | \"unavailable\" | \"invalid\" | \"expired\"" + "\"valid\" | \"invalid\" | \"expired\" | \"unavailable\"" ], "initialIsOpen": false }, @@ -1731,7 +1731,7 @@ "lineNumber": 8 }, "signature": [ - "\"valid\" | \"unavailable\" | \"invalid\" | \"expired\"" + "\"valid\" | \"invalid\" | \"expired\" | \"unavailable\"" ], "initialIsOpen": false }, diff --git a/api_docs/lists.json b/api_docs/lists.json index df8518608f353..1a5da34cf525d 100644 --- a/api_docs/lists.json +++ b/api_docs/lists.json @@ -304,7 +304,7 @@ "signature": [ "({ http, listItem, signal, }: ", "AddExceptionListItemProps", - ") => Promise<{ _version: string | undefined; comments: ({ comment: string; created_at: string; created_by: string; id: string; } & { updated_at?: string | undefined; updated_by?: string | undefined; })[]; created_at: string; created_by: string; description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"date\" | \"text\" | \"keyword\" | \"ip\" | \"long\" | \"double\" | \"date_nanos\" | \"geo_point\" | \"geo_shape\" | \"short\" | \"binary\" | \"date_range\" | \"ip_range\" | \"shape\" | \"integer\" | \"byte\" | \"float\" | \"half_float\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; })[]; field: string; type: \"nested\"; })[]; id: string; item_id: string; list_id: string; meta: object | undefined; name: string; namespace_type: \"single\" | \"agnostic\"; os_types: (\"windows\" | \"linux\" | \"macos\")[]; tags: string[]; tie_breaker_id: string; type: \"simple\"; updated_at: string; updated_by: string; }>" + ") => Promise<{ _version: string | undefined; comments: ({ comment: string; created_at: string; created_by: string; id: string; } & { updated_at?: string | undefined; updated_by?: string | undefined; })[]; created_at: string; created_by: string; description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"date\" | \"text\" | \"keyword\" | \"ip\" | \"long\" | \"double\" | \"date_nanos\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"short\" | \"date_range\" | \"ip_range\" | \"shape\" | \"integer\" | \"byte\" | \"float\" | \"half_float\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; })[]; field: string; type: \"nested\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; })[]; id: string; item_id: string; list_id: string; meta: object | undefined; name: string; namespace_type: \"single\" | \"agnostic\"; os_types: (\"windows\" | \"linux\" | \"macos\")[]; tags: string[]; tie_breaker_id: string; type: \"simple\"; updated_at: string; updated_by: string; }>" ], "description": [], "label": "addExceptionListItemWithValidation", @@ -418,6 +418,38 @@ "returnComment": [], "initialIsOpen": false }, + { + "id": "def-public.transformNewItemOutput", + "type": "Function", + "children": [ + { + "id": "def-public.transformNewItemOutput.$1", + "type": "CompoundType", + "label": "exceptionItem", + "isRequired": true, + "signature": [ + "{ description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"date\" | \"text\" | \"keyword\" | \"ip\" | \"long\" | \"double\" | \"date_nanos\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"short\" | \"date_range\" | \"ip_range\" | \"shape\" | \"integer\" | \"byte\" | \"float\" | \"half_float\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; })[]; field: string; type: \"nested\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; })[]; list_id: string; name: string; type: \"simple\"; } & { comments?: { comment: string; }[] | undefined; item_id?: string | undefined; meta?: object | undefined; namespace_type?: \"single\" | \"agnostic\" | undefined; os_types?: (\"windows\" | \"linux\" | \"macos\")[] | undefined; tags?: string[] | undefined; }" + ], + "description": [], + "source": { + "path": "x-pack/plugins/lists/public/exceptions/transforms.ts", + "lineNumber": 42 + } + } + ], + "signature": [ + "(exceptionItem: { description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"date\" | \"text\" | \"keyword\" | \"ip\" | \"long\" | \"double\" | \"date_nanos\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"short\" | \"date_range\" | \"ip_range\" | \"shape\" | \"integer\" | \"byte\" | \"float\" | \"half_float\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; })[]; field: string; type: \"nested\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; })[]; list_id: string; name: string; type: \"simple\"; } & { comments?: { comment: string; }[] | undefined; item_id?: string | undefined; meta?: object | undefined; namespace_type?: \"single\" | \"agnostic\" | undefined; os_types?: (\"windows\" | \"linux\" | \"macos\")[] | undefined; tags?: string[] | undefined; }) => { description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"date\" | \"text\" | \"keyword\" | \"ip\" | \"long\" | \"double\" | \"date_nanos\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"short\" | \"date_range\" | \"ip_range\" | \"shape\" | \"integer\" | \"byte\" | \"float\" | \"half_float\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; })[]; field: string; type: \"nested\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; })[]; list_id: string; name: string; type: \"simple\"; } & { comments?: { comment: string; }[] | undefined; item_id?: string | undefined; meta?: object | undefined; namespace_type?: \"single\" | \"agnostic\" | undefined; os_types?: (\"windows\" | \"linux\" | \"macos\")[] | undefined; tags?: string[] | undefined; }" + ], + "description": [], + "label": "transformNewItemOutput", + "source": { + "path": "x-pack/plugins/lists/public/exceptions/transforms.ts", + "lineNumber": 41 + }, + "tags": [], + "returnComment": [], + "initialIsOpen": false + }, { "id": "def-public.updateExceptionListItemWithValidation", "type": "Function", @@ -440,7 +472,7 @@ "signature": [ "({ http, listItem, signal, }: ", "UpdateExceptionListItemProps", - ") => Promise<{ _version: string | undefined; comments: ({ comment: string; created_at: string; created_by: string; id: string; } & { updated_at?: string | undefined; updated_by?: string | undefined; })[]; created_at: string; created_by: string; description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"date\" | \"text\" | \"keyword\" | \"ip\" | \"long\" | \"double\" | \"date_nanos\" | \"geo_point\" | \"geo_shape\" | \"short\" | \"binary\" | \"date_range\" | \"ip_range\" | \"shape\" | \"integer\" | \"byte\" | \"float\" | \"half_float\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; })[]; field: string; type: \"nested\"; })[]; id: string; item_id: string; list_id: string; meta: object | undefined; name: string; namespace_type: \"single\" | \"agnostic\"; os_types: (\"windows\" | \"linux\" | \"macos\")[]; tags: string[]; tie_breaker_id: string; type: \"simple\"; updated_at: string; updated_by: string; }>" + ") => Promise<{ _version: string | undefined; comments: ({ comment: string; created_at: string; created_by: string; id: string; } & { updated_at?: string | undefined; updated_by?: string | undefined; })[]; created_at: string; created_by: string; description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"date\" | \"text\" | \"keyword\" | \"ip\" | \"long\" | \"double\" | \"date_nanos\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"short\" | \"date_range\" | \"ip_range\" | \"shape\" | \"integer\" | \"byte\" | \"float\" | \"half_float\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; })[]; field: string; type: \"nested\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; })[]; id: string; item_id: string; list_id: string; meta: object | undefined; name: string; namespace_type: \"single\" | \"agnostic\"; os_types: (\"windows\" | \"linux\" | \"macos\")[]; tags: string[]; tie_breaker_id: string; type: \"simple\"; updated_at: string; updated_by: string; }>" ], "description": [], "label": "updateExceptionListItemWithValidation", @@ -605,7 +637,7 @@ "OptionalSignalArgs", "<", "DeleteListParams", - ">], { _version: string | undefined; created_at: string; created_by: string; description: string; deserializer: string | undefined; id: string; immutable: boolean; meta: object | undefined; name: string; serializer: string | undefined; tie_breaker_id: string; type: \"boolean\" | \"date\" | \"text\" | \"keyword\" | \"ip\" | \"long\" | \"double\" | \"date_nanos\" | \"geo_point\" | \"geo_shape\" | \"short\" | \"binary\" | \"date_range\" | \"ip_range\" | \"shape\" | \"integer\" | \"byte\" | \"float\" | \"half_float\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\"; updated_at: string; updated_by: string; version: number; }>" + ">], { _version: string | undefined; created_at: string; created_by: string; description: string; deserializer: string | undefined; id: string; immutable: boolean; meta: object | undefined; name: string; serializer: string | undefined; tie_breaker_id: string; type: \"boolean\" | \"date\" | \"text\" | \"keyword\" | \"ip\" | \"long\" | \"double\" | \"date_nanos\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"short\" | \"date_range\" | \"ip_range\" | \"shape\" | \"integer\" | \"byte\" | \"float\" | \"half_float\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\"; updated_at: string; updated_by: string; version: number; }>" ], "description": [], "label": "useDeleteList", @@ -725,7 +757,7 @@ "OptionalSignalArgs", "<", "FindListsParams", - ">], { cursor: string; data: { _version: string | undefined; created_at: string; created_by: string; description: string; deserializer: string | undefined; id: string; immutable: boolean; meta: object | undefined; name: string; serializer: string | undefined; tie_breaker_id: string; type: \"boolean\" | \"date\" | \"text\" | \"keyword\" | \"ip\" | \"long\" | \"double\" | \"date_nanos\" | \"geo_point\" | \"geo_shape\" | \"short\" | \"binary\" | \"date_range\" | \"ip_range\" | \"shape\" | \"integer\" | \"byte\" | \"float\" | \"half_float\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\"; updated_at: string; updated_by: string; version: number; }[]; page: number; per_page: number; total: number; }>" + ">], { cursor: string; data: { _version: string | undefined; created_at: string; created_by: string; description: string; deserializer: string | undefined; id: string; immutable: boolean; meta: object | undefined; name: string; serializer: string | undefined; tie_breaker_id: string; type: \"boolean\" | \"date\" | \"text\" | \"keyword\" | \"ip\" | \"long\" | \"double\" | \"date_nanos\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"short\" | \"date_range\" | \"ip_range\" | \"shape\" | \"integer\" | \"byte\" | \"float\" | \"half_float\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\"; updated_at: string; updated_by: string; version: number; }[]; page: number; per_page: number; total: number; }>" ], "description": [], "label": "useFindLists", @@ -748,7 +780,7 @@ "OptionalSignalArgs", "<", "ImportListParams", - ">], { _version: string | undefined; created_at: string; created_by: string; description: string; deserializer: string | undefined; id: string; immutable: boolean; meta: object | undefined; name: string; serializer: string | undefined; tie_breaker_id: string; type: \"boolean\" | \"date\" | \"text\" | \"keyword\" | \"ip\" | \"long\" | \"double\" | \"date_nanos\" | \"geo_point\" | \"geo_shape\" | \"short\" | \"binary\" | \"date_range\" | \"ip_range\" | \"shape\" | \"integer\" | \"byte\" | \"float\" | \"half_float\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\"; updated_at: string; updated_by: string; version: number; }>" + ">], { _version: string | undefined; created_at: string; created_by: string; description: string; deserializer: string | undefined; id: string; immutable: boolean; meta: object | undefined; name: string; serializer: string | undefined; tie_breaker_id: string; type: \"boolean\" | \"date\" | \"text\" | \"keyword\" | \"ip\" | \"long\" | \"double\" | \"date_nanos\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"short\" | \"date_range\" | \"ip_range\" | \"shape\" | \"integer\" | \"byte\" | \"float\" | \"half_float\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\"; updated_at: string; updated_by: string; version: number; }>" ], "description": [], "label": "useImportList", @@ -1192,7 +1224,7 @@ "lineNumber": 46 }, "signature": [ - "{ _version: string | undefined; comments: ({ comment: string; created_at: string; created_by: string; id: string; } & { updated_at?: string | undefined; updated_by?: string | undefined; })[]; created_at: string; created_by: string; description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"date\" | \"text\" | \"keyword\" | \"ip\" | \"long\" | \"double\" | \"date_nanos\" | \"geo_point\" | \"geo_shape\" | \"short\" | \"binary\" | \"date_range\" | \"ip_range\" | \"shape\" | \"integer\" | \"byte\" | \"float\" | \"half_float\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; })[]; field: string; type: \"nested\"; })[]; id: string; item_id: string; list_id: string; meta: object | undefined; name: string; namespace_type: \"single\" | \"agnostic\"; os_types: (\"windows\" | \"linux\" | \"macos\")[]; tags: string[]; tie_breaker_id: string; type: \"simple\"; updated_at: string; updated_by: string; }[]" + "{ _version: string | undefined; comments: ({ comment: string; created_at: string; created_by: string; id: string; } & { updated_at?: string | undefined; updated_by?: string | undefined; })[]; created_at: string; created_by: string; description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"date\" | \"text\" | \"keyword\" | \"ip\" | \"long\" | \"double\" | \"date_nanos\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"short\" | \"date_range\" | \"ip_range\" | \"shape\" | \"integer\" | \"byte\" | \"float\" | \"half_float\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; })[]; field: string; type: \"nested\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; })[]; id: string; item_id: string; list_id: string; meta: object | undefined; name: string; namespace_type: \"single\" | \"agnostic\"; os_types: (\"windows\" | \"linux\" | \"macos\")[]; tags: string[]; tie_breaker_id: string; type: \"simple\"; updated_at: string; updated_by: string; }[]" ] }, { @@ -1349,7 +1381,7 @@ "description": [], "source": { "path": "x-pack/plugins/lists/server/services/exception_lists/exception_list_client.ts", - "lineNumber": 61 + "lineNumber": 62 } } ], @@ -1357,7 +1389,7 @@ "returnComment": [], "source": { "path": "x-pack/plugins/lists/server/services/exception_lists/exception_list_client.ts", - "lineNumber": 61 + "lineNumber": 62 } }, { @@ -1375,7 +1407,7 @@ "description": [], "source": { "path": "x-pack/plugins/lists/server/services/exception_lists/exception_list_client.ts", - "lineNumber": 66 + "lineNumber": 67 } } ], @@ -1388,7 +1420,7 @@ "label": "getExceptionList", "source": { "path": "x-pack/plugins/lists/server/services/exception_lists/exception_list_client.ts", - "lineNumber": 66 + "lineNumber": 67 }, "tags": [], "returnComment": [] @@ -1408,20 +1440,20 @@ "description": [], "source": { "path": "x-pack/plugins/lists/server/services/exception_lists/exception_list_client.ts", - "lineNumber": 75 + "lineNumber": 76 } } ], "signature": [ "({ itemId, id, namespaceType, }: ", "GetExceptionListItemOptions", - ") => Promise<{ _version: string | undefined; comments: ({ comment: string; created_at: string; created_by: string; id: string; } & { updated_at?: string | undefined; updated_by?: string | undefined; })[]; created_at: string; created_by: string; description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"date\" | \"text\" | \"keyword\" | \"ip\" | \"long\" | \"double\" | \"date_nanos\" | \"geo_point\" | \"geo_shape\" | \"short\" | \"binary\" | \"date_range\" | \"ip_range\" | \"shape\" | \"integer\" | \"byte\" | \"float\" | \"half_float\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; })[]; field: string; type: \"nested\"; })[]; id: string; item_id: string; list_id: string; meta: object | undefined; name: string; namespace_type: \"single\" | \"agnostic\"; os_types: (\"windows\" | \"linux\" | \"macos\")[]; tags: string[]; tie_breaker_id: string; type: \"simple\"; updated_at: string; updated_by: string; } | null>" + ") => Promise<{ _version: string | undefined; comments: ({ comment: string; created_at: string; created_by: string; id: string; } & { updated_at?: string | undefined; updated_by?: string | undefined; })[]; created_at: string; created_by: string; description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"date\" | \"text\" | \"keyword\" | \"ip\" | \"long\" | \"double\" | \"date_nanos\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"short\" | \"date_range\" | \"ip_range\" | \"shape\" | \"integer\" | \"byte\" | \"float\" | \"half_float\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; })[]; field: string; type: \"nested\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; })[]; id: string; item_id: string; list_id: string; meta: object | undefined; name: string; namespace_type: \"single\" | \"agnostic\"; os_types: (\"windows\" | \"linux\" | \"macos\")[]; tags: string[]; tie_breaker_id: string; type: \"simple\"; updated_at: string; updated_by: string; } | null>" ], "description": [], "label": "getExceptionListItem", "source": { "path": "x-pack/plugins/lists/server/services/exception_lists/exception_list_client.ts", - "lineNumber": 75 + "lineNumber": 76 }, "tags": [], "returnComment": [] @@ -1439,7 +1471,7 @@ "label": "createEndpointList", "source": { "path": "x-pack/plugins/lists/server/services/exception_lists/exception_list_client.ts", - "lineNumber": 90 + "lineNumber": 91 }, "tags": [], "returnComment": [ @@ -1459,7 +1491,25 @@ "label": "createTrustedAppsList", "source": { "path": "x-pack/plugins/lists/server/services/exception_lists/exception_list_client.ts", - "lineNumber": 102 + "lineNumber": 103 + }, + "tags": [], + "returnComment": [] + }, + { + "id": "def-server.ExceptionListClient.createEndpointEventFiltersList", + "type": "Function", + "children": [], + "signature": [ + "() => Promise<{ _version: string | undefined; created_at: string; created_by: string; description: string; id: string; immutable: boolean; list_id: string; meta: object | undefined; name: string; namespace_type: \"single\" | \"agnostic\"; os_types: (\"windows\" | \"linux\" | \"macos\")[]; tags: string[]; tie_breaker_id: string; type: \"endpoint\" | \"detection\" | \"endpoint_events\"; updated_at: string; updated_by: string; version: number; } | null>" + ], + "description": [ + "\nCreate the Endpoint Event Filters Agnostic list if it does not yet exist (`null` is returned if it does exist)" + ], + "label": "createEndpointEventFiltersList", + "source": { + "path": "x-pack/plugins/lists/server/services/exception_lists/exception_list_client.ts", + "lineNumber": 115 }, "tags": [], "returnComment": [] @@ -1479,14 +1529,14 @@ "description": [], "source": { "path": "x-pack/plugins/lists/server/services/exception_lists/exception_list_client.ts", - "lineNumber": 116 + "lineNumber": 129 } } ], "signature": [ "({ comments, description, entries, itemId, meta, name, osTypes, tags, type, }: ", "CreateEndpointListItemOptions", - ") => Promise<{ _version: string | undefined; comments: ({ comment: string; created_at: string; created_by: string; id: string; } & { updated_at?: string | undefined; updated_by?: string | undefined; })[]; created_at: string; created_by: string; description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"date\" | \"text\" | \"keyword\" | \"ip\" | \"long\" | \"double\" | \"date_nanos\" | \"geo_point\" | \"geo_shape\" | \"short\" | \"binary\" | \"date_range\" | \"ip_range\" | \"shape\" | \"integer\" | \"byte\" | \"float\" | \"half_float\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; })[]; field: string; type: \"nested\"; })[]; id: string; item_id: string; list_id: string; meta: object | undefined; name: string; namespace_type: \"single\" | \"agnostic\"; os_types: (\"windows\" | \"linux\" | \"macos\")[]; tags: string[]; tie_breaker_id: string; type: \"simple\"; updated_at: string; updated_by: string; }>" + ") => Promise<{ _version: string | undefined; comments: ({ comment: string; created_at: string; created_by: string; id: string; } & { updated_at?: string | undefined; updated_by?: string | undefined; })[]; created_at: string; created_by: string; description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"date\" | \"text\" | \"keyword\" | \"ip\" | \"long\" | \"double\" | \"date_nanos\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"short\" | \"date_range\" | \"ip_range\" | \"shape\" | \"integer\" | \"byte\" | \"float\" | \"half_float\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; })[]; field: string; type: \"nested\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; })[]; id: string; item_id: string; list_id: string; meta: object | undefined; name: string; namespace_type: \"single\" | \"agnostic\"; os_types: (\"windows\" | \"linux\" | \"macos\")[]; tags: string[]; tie_breaker_id: string; type: \"simple\"; updated_at: string; updated_by: string; }>" ], "description": [ "\nThis is the same as \"createListItem\" except it applies specifically to the agnostic endpoint list and will\nauto-call the \"createEndpointList\" for you so that you have the best chance of the agnostic endpoint\nbeing there and existing before the item is inserted into the agnostic endpoint list." @@ -1494,7 +1544,7 @@ "label": "createEndpointListItem", "source": { "path": "x-pack/plugins/lists/server/services/exception_lists/exception_list_client.ts", - "lineNumber": 116 + "lineNumber": 129 }, "tags": [], "returnComment": [] @@ -1514,14 +1564,14 @@ "description": [], "source": { "path": "x-pack/plugins/lists/server/services/exception_lists/exception_list_client.ts", - "lineNumber": 152 + "lineNumber": 165 } } ], "signature": [ "({ _version, comments, description, entries, id, itemId, meta, name, osTypes, tags, type, }: ", "UpdateEndpointListItemOptions", - ") => Promise<{ _version: string | undefined; comments: ({ comment: string; created_at: string; created_by: string; id: string; } & { updated_at?: string | undefined; updated_by?: string | undefined; })[]; created_at: string; created_by: string; description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"date\" | \"text\" | \"keyword\" | \"ip\" | \"long\" | \"double\" | \"date_nanos\" | \"geo_point\" | \"geo_shape\" | \"short\" | \"binary\" | \"date_range\" | \"ip_range\" | \"shape\" | \"integer\" | \"byte\" | \"float\" | \"half_float\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; })[]; field: string; type: \"nested\"; })[]; id: string; item_id: string; list_id: string; meta: object | undefined; name: string; namespace_type: \"single\" | \"agnostic\"; os_types: (\"windows\" | \"linux\" | \"macos\")[]; tags: string[]; tie_breaker_id: string; type: \"simple\"; updated_at: string; updated_by: string; } | null>" + ") => Promise<{ _version: string | undefined; comments: ({ comment: string; created_at: string; created_by: string; id: string; } & { updated_at?: string | undefined; updated_by?: string | undefined; })[]; created_at: string; created_by: string; description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"date\" | \"text\" | \"keyword\" | \"ip\" | \"long\" | \"double\" | \"date_nanos\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"short\" | \"date_range\" | \"ip_range\" | \"shape\" | \"integer\" | \"byte\" | \"float\" | \"half_float\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; })[]; field: string; type: \"nested\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; })[]; id: string; item_id: string; list_id: string; meta: object | undefined; name: string; namespace_type: \"single\" | \"agnostic\"; os_types: (\"windows\" | \"linux\" | \"macos\")[]; tags: string[]; tie_breaker_id: string; type: \"simple\"; updated_at: string; updated_by: string; } | null>" ], "description": [ "\nThis is the same as \"updateExceptionListItem\" except it applies specifically to the endpoint list and will\nauto-call the \"createEndpointList\" for you so that you have the best chance of the endpoint\nbeing there if it did not exist before. If the list did not exist before, then creating it here will still cause a\nreturn of null but at least the list exists again." @@ -1529,7 +1579,7 @@ "label": "updateEndpointListItem", "source": { "path": "x-pack/plugins/lists/server/services/exception_lists/exception_list_client.ts", - "lineNumber": 152 + "lineNumber": 165 }, "tags": [], "returnComment": [] @@ -1549,14 +1599,14 @@ "description": [], "source": { "path": "x-pack/plugins/lists/server/services/exception_lists/exception_list_client.ts", - "lineNumber": 188 + "lineNumber": 201 } } ], "signature": [ "({ itemId, id, }: ", "GetEndpointListItemOptions", - ") => Promise<{ _version: string | undefined; comments: ({ comment: string; created_at: string; created_by: string; id: string; } & { updated_at?: string | undefined; updated_by?: string | undefined; })[]; created_at: string; created_by: string; description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"date\" | \"text\" | \"keyword\" | \"ip\" | \"long\" | \"double\" | \"date_nanos\" | \"geo_point\" | \"geo_shape\" | \"short\" | \"binary\" | \"date_range\" | \"ip_range\" | \"shape\" | \"integer\" | \"byte\" | \"float\" | \"half_float\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; })[]; field: string; type: \"nested\"; })[]; id: string; item_id: string; list_id: string; meta: object | undefined; name: string; namespace_type: \"single\" | \"agnostic\"; os_types: (\"windows\" | \"linux\" | \"macos\")[]; tags: string[]; tie_breaker_id: string; type: \"simple\"; updated_at: string; updated_by: string; } | null>" + ") => Promise<{ _version: string | undefined; comments: ({ comment: string; created_at: string; created_by: string; id: string; } & { updated_at?: string | undefined; updated_by?: string | undefined; })[]; created_at: string; created_by: string; description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"date\" | \"text\" | \"keyword\" | \"ip\" | \"long\" | \"double\" | \"date_nanos\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"short\" | \"date_range\" | \"ip_range\" | \"shape\" | \"integer\" | \"byte\" | \"float\" | \"half_float\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; })[]; field: string; type: \"nested\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; })[]; id: string; item_id: string; list_id: string; meta: object | undefined; name: string; namespace_type: \"single\" | \"agnostic\"; os_types: (\"windows\" | \"linux\" | \"macos\")[]; tags: string[]; tie_breaker_id: string; type: \"simple\"; updated_at: string; updated_by: string; } | null>" ], "description": [ "\nThis is the same as \"getExceptionListItem\" except it applies specifically to the endpoint list." @@ -1564,7 +1614,7 @@ "label": "getEndpointListItem", "source": { "path": "x-pack/plugins/lists/server/services/exception_lists/exception_list_client.ts", - "lineNumber": 188 + "lineNumber": 201 }, "tags": [], "returnComment": [] @@ -1584,7 +1634,7 @@ "description": [], "source": { "path": "x-pack/plugins/lists/server/services/exception_lists/exception_list_client.ts", - "lineNumber": 196 + "lineNumber": 209 } } ], @@ -1597,7 +1647,7 @@ "label": "createExceptionList", "source": { "path": "x-pack/plugins/lists/server/services/exception_lists/exception_list_client.ts", - "lineNumber": 196 + "lineNumber": 209 }, "tags": [], "returnComment": [] @@ -1617,7 +1667,7 @@ "description": [], "source": { "path": "x-pack/plugins/lists/server/services/exception_lists/exception_list_client.ts", - "lineNumber": 223 + "lineNumber": 236 } } ], @@ -1630,7 +1680,7 @@ "label": "updateExceptionList", "source": { "path": "x-pack/plugins/lists/server/services/exception_lists/exception_list_client.ts", - "lineNumber": 223 + "lineNumber": 236 }, "tags": [], "returnComment": [] @@ -1650,7 +1700,7 @@ "description": [], "source": { "path": "x-pack/plugins/lists/server/services/exception_lists/exception_list_client.ts", - "lineNumber": 254 + "lineNumber": 267 } } ], @@ -1663,7 +1713,7 @@ "label": "deleteExceptionList", "source": { "path": "x-pack/plugins/lists/server/services/exception_lists/exception_list_client.ts", - "lineNumber": 254 + "lineNumber": 267 }, "tags": [], "returnComment": [] @@ -1689,7 +1739,7 @@ "description": [], "source": { "path": "x-pack/plugins/lists/server/services/exception_lists/exception_list_client.ts", - "lineNumber": 268 + "lineNumber": 281 } } ], @@ -1702,13 +1752,13 @@ "section": "def-server.CreateExceptionListItemOptions", "text": "CreateExceptionListItemOptions" }, - ") => Promise<{ _version: string | undefined; comments: ({ comment: string; created_at: string; created_by: string; id: string; } & { updated_at?: string | undefined; updated_by?: string | undefined; })[]; created_at: string; created_by: string; description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"date\" | \"text\" | \"keyword\" | \"ip\" | \"long\" | \"double\" | \"date_nanos\" | \"geo_point\" | \"geo_shape\" | \"short\" | \"binary\" | \"date_range\" | \"ip_range\" | \"shape\" | \"integer\" | \"byte\" | \"float\" | \"half_float\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; })[]; field: string; type: \"nested\"; })[]; id: string; item_id: string; list_id: string; meta: object | undefined; name: string; namespace_type: \"single\" | \"agnostic\"; os_types: (\"windows\" | \"linux\" | \"macos\")[]; tags: string[]; tie_breaker_id: string; type: \"simple\"; updated_at: string; updated_by: string; }>" + ") => Promise<{ _version: string | undefined; comments: ({ comment: string; created_at: string; created_by: string; id: string; } & { updated_at?: string | undefined; updated_by?: string | undefined; })[]; created_at: string; created_by: string; description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"date\" | \"text\" | \"keyword\" | \"ip\" | \"long\" | \"double\" | \"date_nanos\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"short\" | \"date_range\" | \"ip_range\" | \"shape\" | \"integer\" | \"byte\" | \"float\" | \"half_float\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; })[]; field: string; type: \"nested\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; })[]; id: string; item_id: string; list_id: string; meta: object | undefined; name: string; namespace_type: \"single\" | \"agnostic\"; os_types: (\"windows\" | \"linux\" | \"macos\")[]; tags: string[]; tie_breaker_id: string; type: \"simple\"; updated_at: string; updated_by: string; }>" ], "description": [], "label": "createExceptionListItem", "source": { "path": "x-pack/plugins/lists/server/services/exception_lists/exception_list_client.ts", - "lineNumber": 268 + "lineNumber": 281 }, "tags": [], "returnComment": [] @@ -1734,7 +1784,7 @@ "description": [], "source": { "path": "x-pack/plugins/lists/server/services/exception_lists/exception_list_client.ts", - "lineNumber": 299 + "lineNumber": 312 } } ], @@ -1747,13 +1797,13 @@ "section": "def-server.UpdateExceptionListItemOptions", "text": "UpdateExceptionListItemOptions" }, - ") => Promise<{ _version: string | undefined; comments: ({ comment: string; created_at: string; created_by: string; id: string; } & { updated_at?: string | undefined; updated_by?: string | undefined; })[]; created_at: string; created_by: string; description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"date\" | \"text\" | \"keyword\" | \"ip\" | \"long\" | \"double\" | \"date_nanos\" | \"geo_point\" | \"geo_shape\" | \"short\" | \"binary\" | \"date_range\" | \"ip_range\" | \"shape\" | \"integer\" | \"byte\" | \"float\" | \"half_float\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; })[]; field: string; type: \"nested\"; })[]; id: string; item_id: string; list_id: string; meta: object | undefined; name: string; namespace_type: \"single\" | \"agnostic\"; os_types: (\"windows\" | \"linux\" | \"macos\")[]; tags: string[]; tie_breaker_id: string; type: \"simple\"; updated_at: string; updated_by: string; } | null>" + ") => Promise<{ _version: string | undefined; comments: ({ comment: string; created_at: string; created_by: string; id: string; } & { updated_at?: string | undefined; updated_by?: string | undefined; })[]; created_at: string; created_by: string; description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"date\" | \"text\" | \"keyword\" | \"ip\" | \"long\" | \"double\" | \"date_nanos\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"short\" | \"date_range\" | \"ip_range\" | \"shape\" | \"integer\" | \"byte\" | \"float\" | \"half_float\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; })[]; field: string; type: \"nested\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; })[]; id: string; item_id: string; list_id: string; meta: object | undefined; name: string; namespace_type: \"single\" | \"agnostic\"; os_types: (\"windows\" | \"linux\" | \"macos\")[]; tags: string[]; tie_breaker_id: string; type: \"simple\"; updated_at: string; updated_by: string; } | null>" ], "description": [], "label": "updateExceptionListItem", "source": { "path": "x-pack/plugins/lists/server/services/exception_lists/exception_list_client.ts", - "lineNumber": 299 + "lineNumber": 312 }, "tags": [], "returnComment": [] @@ -1773,20 +1823,20 @@ "description": [], "source": { "path": "x-pack/plugins/lists/server/services/exception_lists/exception_list_client.ts", - "lineNumber": 332 + "lineNumber": 345 } } ], "signature": [ "({ id, itemId, namespaceType, }: ", "DeleteExceptionListItemOptions", - ") => Promise<{ _version: string | undefined; comments: ({ comment: string; created_at: string; created_by: string; id: string; } & { updated_at?: string | undefined; updated_by?: string | undefined; })[]; created_at: string; created_by: string; description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"date\" | \"text\" | \"keyword\" | \"ip\" | \"long\" | \"double\" | \"date_nanos\" | \"geo_point\" | \"geo_shape\" | \"short\" | \"binary\" | \"date_range\" | \"ip_range\" | \"shape\" | \"integer\" | \"byte\" | \"float\" | \"half_float\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; })[]; field: string; type: \"nested\"; })[]; id: string; item_id: string; list_id: string; meta: object | undefined; name: string; namespace_type: \"single\" | \"agnostic\"; os_types: (\"windows\" | \"linux\" | \"macos\")[]; tags: string[]; tie_breaker_id: string; type: \"simple\"; updated_at: string; updated_by: string; } | null>" + ") => Promise<{ _version: string | undefined; comments: ({ comment: string; created_at: string; created_by: string; id: string; } & { updated_at?: string | undefined; updated_by?: string | undefined; })[]; created_at: string; created_by: string; description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"date\" | \"text\" | \"keyword\" | \"ip\" | \"long\" | \"double\" | \"date_nanos\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"short\" | \"date_range\" | \"ip_range\" | \"shape\" | \"integer\" | \"byte\" | \"float\" | \"half_float\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; })[]; field: string; type: \"nested\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; })[]; id: string; item_id: string; list_id: string; meta: object | undefined; name: string; namespace_type: \"single\" | \"agnostic\"; os_types: (\"windows\" | \"linux\" | \"macos\")[]; tags: string[]; tie_breaker_id: string; type: \"simple\"; updated_at: string; updated_by: string; } | null>" ], "description": [], "label": "deleteExceptionListItem", "source": { "path": "x-pack/plugins/lists/server/services/exception_lists/exception_list_client.ts", - "lineNumber": 332 + "lineNumber": 345 }, "tags": [], "returnComment": [] @@ -1806,7 +1856,7 @@ "description": [], "source": { "path": "x-pack/plugins/lists/server/services/exception_lists/exception_list_client.ts", - "lineNumber": 346 + "lineNumber": 359 } } ], @@ -1819,7 +1869,7 @@ "label": "deleteExceptionListItemById", "source": { "path": "x-pack/plugins/lists/server/services/exception_lists/exception_list_client.ts", - "lineNumber": 346 + "lineNumber": 359 }, "tags": [], "returnComment": [] @@ -1839,14 +1889,14 @@ "description": [], "source": { "path": "x-pack/plugins/lists/server/services/exception_lists/exception_list_client.ts", - "lineNumber": 361 + "lineNumber": 374 } } ], "signature": [ "({ id, itemId, }: ", "DeleteEndpointListItemOptions", - ") => Promise<{ _version: string | undefined; comments: ({ comment: string; created_at: string; created_by: string; id: string; } & { updated_at?: string | undefined; updated_by?: string | undefined; })[]; created_at: string; created_by: string; description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"date\" | \"text\" | \"keyword\" | \"ip\" | \"long\" | \"double\" | \"date_nanos\" | \"geo_point\" | \"geo_shape\" | \"short\" | \"binary\" | \"date_range\" | \"ip_range\" | \"shape\" | \"integer\" | \"byte\" | \"float\" | \"half_float\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; })[]; field: string; type: \"nested\"; })[]; id: string; item_id: string; list_id: string; meta: object | undefined; name: string; namespace_type: \"single\" | \"agnostic\"; os_types: (\"windows\" | \"linux\" | \"macos\")[]; tags: string[]; tie_breaker_id: string; type: \"simple\"; updated_at: string; updated_by: string; } | null>" + ") => Promise<{ _version: string | undefined; comments: ({ comment: string; created_at: string; created_by: string; id: string; } & { updated_at?: string | undefined; updated_by?: string | undefined; })[]; created_at: string; created_by: string; description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"date\" | \"text\" | \"keyword\" | \"ip\" | \"long\" | \"double\" | \"date_nanos\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"short\" | \"date_range\" | \"ip_range\" | \"shape\" | \"integer\" | \"byte\" | \"float\" | \"half_float\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; })[]; field: string; type: \"nested\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; })[]; id: string; item_id: string; list_id: string; meta: object | undefined; name: string; namespace_type: \"single\" | \"agnostic\"; os_types: (\"windows\" | \"linux\" | \"macos\")[]; tags: string[]; tie_breaker_id: string; type: \"simple\"; updated_at: string; updated_by: string; } | null>" ], "description": [ "\nThis is the same as \"deleteExceptionListItem\" except it applies specifically to the endpoint list." @@ -1854,7 +1904,7 @@ "label": "deleteEndpointListItem", "source": { "path": "x-pack/plugins/lists/server/services/exception_lists/exception_list_client.ts", - "lineNumber": 361 + "lineNumber": 374 }, "tags": [], "returnComment": [] @@ -1874,20 +1924,20 @@ "description": [], "source": { "path": "x-pack/plugins/lists/server/services/exception_lists/exception_list_client.ts", - "lineNumber": 374 + "lineNumber": 387 } } ], "signature": [ "({ listId, filter, perPage, page, sortField, sortOrder, namespaceType, }: ", "FindExceptionListItemOptions", - ") => Promise<{ data: { _version: string | undefined; comments: ({ comment: string; created_at: string; created_by: string; id: string; } & { updated_at?: string | undefined; updated_by?: string | undefined; })[]; created_at: string; created_by: string; description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"date\" | \"text\" | \"keyword\" | \"ip\" | \"long\" | \"double\" | \"date_nanos\" | \"geo_point\" | \"geo_shape\" | \"short\" | \"binary\" | \"date_range\" | \"ip_range\" | \"shape\" | \"integer\" | \"byte\" | \"float\" | \"half_float\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; })[]; field: string; type: \"nested\"; })[]; id: string; item_id: string; list_id: string; meta: object | undefined; name: string; namespace_type: \"single\" | \"agnostic\"; os_types: (\"windows\" | \"linux\" | \"macos\")[]; tags: string[]; tie_breaker_id: string; type: \"simple\"; updated_at: string; updated_by: string; }[]; page: number; per_page: number; total: number; } | null>" + ") => Promise<{ data: { _version: string | undefined; comments: ({ comment: string; created_at: string; created_by: string; id: string; } & { updated_at?: string | undefined; updated_by?: string | undefined; })[]; created_at: string; created_by: string; description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"date\" | \"text\" | \"keyword\" | \"ip\" | \"long\" | \"double\" | \"date_nanos\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"short\" | \"date_range\" | \"ip_range\" | \"shape\" | \"integer\" | \"byte\" | \"float\" | \"half_float\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; })[]; field: string; type: \"nested\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; })[]; id: string; item_id: string; list_id: string; meta: object | undefined; name: string; namespace_type: \"single\" | \"agnostic\"; os_types: (\"windows\" | \"linux\" | \"macos\")[]; tags: string[]; tie_breaker_id: string; type: \"simple\"; updated_at: string; updated_by: string; }[]; page: number; per_page: number; total: number; } | null>" ], "description": [], "label": "findExceptionListItem", "source": { "path": "x-pack/plugins/lists/server/services/exception_lists/exception_list_client.ts", - "lineNumber": 374 + "lineNumber": 387 }, "tags": [], "returnComment": [] @@ -1907,20 +1957,20 @@ "description": [], "source": { "path": "x-pack/plugins/lists/server/services/exception_lists/exception_list_client.ts", - "lineNumber": 396 + "lineNumber": 409 } } ], "signature": [ "({ listId, filter, perPage, page, sortField, sortOrder, namespaceType, }: ", "FindExceptionListsItemOptions", - ") => Promise<{ data: { _version: string | undefined; comments: ({ comment: string; created_at: string; created_by: string; id: string; } & { updated_at?: string | undefined; updated_by?: string | undefined; })[]; created_at: string; created_by: string; description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"date\" | \"text\" | \"keyword\" | \"ip\" | \"long\" | \"double\" | \"date_nanos\" | \"geo_point\" | \"geo_shape\" | \"short\" | \"binary\" | \"date_range\" | \"ip_range\" | \"shape\" | \"integer\" | \"byte\" | \"float\" | \"half_float\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; })[]; field: string; type: \"nested\"; })[]; id: string; item_id: string; list_id: string; meta: object | undefined; name: string; namespace_type: \"single\" | \"agnostic\"; os_types: (\"windows\" | \"linux\" | \"macos\")[]; tags: string[]; tie_breaker_id: string; type: \"simple\"; updated_at: string; updated_by: string; }[]; page: number; per_page: number; total: number; } | null>" + ") => Promise<{ data: { _version: string | undefined; comments: ({ comment: string; created_at: string; created_by: string; id: string; } & { updated_at?: string | undefined; updated_by?: string | undefined; })[]; created_at: string; created_by: string; description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"date\" | \"text\" | \"keyword\" | \"ip\" | \"long\" | \"double\" | \"date_nanos\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"short\" | \"date_range\" | \"ip_range\" | \"shape\" | \"integer\" | \"byte\" | \"float\" | \"half_float\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; })[]; field: string; type: \"nested\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; })[]; id: string; item_id: string; list_id: string; meta: object | undefined; name: string; namespace_type: \"single\" | \"agnostic\"; os_types: (\"windows\" | \"linux\" | \"macos\")[]; tags: string[]; tie_breaker_id: string; type: \"simple\"; updated_at: string; updated_by: string; }[]; page: number; per_page: number; total: number; } | null>" ], "description": [], "label": "findExceptionListsItem", "source": { "path": "x-pack/plugins/lists/server/services/exception_lists/exception_list_client.ts", - "lineNumber": 396 + "lineNumber": 409 }, "tags": [], "returnComment": [] @@ -1940,20 +1990,20 @@ "description": [], "source": { "path": "x-pack/plugins/lists/server/services/exception_lists/exception_list_client.ts", - "lineNumber": 418 + "lineNumber": 431 } } ], "signature": [ "({ perPage, page, sortField, sortOrder, valueListId, }: ", "FindValueListExceptionListsItems", - ") => Promise<{ data: { _version: string | undefined; comments: ({ comment: string; created_at: string; created_by: string; id: string; } & { updated_at?: string | undefined; updated_by?: string | undefined; })[]; created_at: string; created_by: string; description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"date\" | \"text\" | \"keyword\" | \"ip\" | \"long\" | \"double\" | \"date_nanos\" | \"geo_point\" | \"geo_shape\" | \"short\" | \"binary\" | \"date_range\" | \"ip_range\" | \"shape\" | \"integer\" | \"byte\" | \"float\" | \"half_float\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; })[]; field: string; type: \"nested\"; })[]; id: string; item_id: string; list_id: string; meta: object | undefined; name: string; namespace_type: \"single\" | \"agnostic\"; os_types: (\"windows\" | \"linux\" | \"macos\")[]; tags: string[]; tie_breaker_id: string; type: \"simple\"; updated_at: string; updated_by: string; }[]; page: number; per_page: number; total: number; } | null>" + ") => Promise<{ data: { _version: string | undefined; comments: ({ comment: string; created_at: string; created_by: string; id: string; } & { updated_at?: string | undefined; updated_by?: string | undefined; })[]; created_at: string; created_by: string; description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"date\" | \"text\" | \"keyword\" | \"ip\" | \"long\" | \"double\" | \"date_nanos\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"short\" | \"date_range\" | \"ip_range\" | \"shape\" | \"integer\" | \"byte\" | \"float\" | \"half_float\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; })[]; field: string; type: \"nested\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; })[]; id: string; item_id: string; list_id: string; meta: object | undefined; name: string; namespace_type: \"single\" | \"agnostic\"; os_types: (\"windows\" | \"linux\" | \"macos\")[]; tags: string[]; tie_breaker_id: string; type: \"simple\"; updated_at: string; updated_by: string; }[]; page: number; per_page: number; total: number; } | null>" ], "description": [], "label": "findValueListExceptionListItems", "source": { "path": "x-pack/plugins/lists/server/services/exception_lists/exception_list_client.ts", - "lineNumber": 418 + "lineNumber": 431 }, "tags": [], "returnComment": [] @@ -1973,7 +2023,7 @@ "description": [], "source": { "path": "x-pack/plugins/lists/server/services/exception_lists/exception_list_client.ts", - "lineNumber": 436 + "lineNumber": 449 } } ], @@ -1986,7 +2036,7 @@ "label": "findExceptionList", "source": { "path": "x-pack/plugins/lists/server/services/exception_lists/exception_list_client.ts", - "lineNumber": 436 + "lineNumber": 449 }, "tags": [], "returnComment": [] @@ -2006,14 +2056,14 @@ "description": [], "source": { "path": "x-pack/plugins/lists/server/services/exception_lists/exception_list_client.ts", - "lineNumber": 464 + "lineNumber": 477 } } ], "signature": [ "({ filter, perPage, page, sortField, sortOrder, }: ", "FindEndpointListItemOptions", - ") => Promise<{ data: { _version: string | undefined; comments: ({ comment: string; created_at: string; created_by: string; id: string; } & { updated_at?: string | undefined; updated_by?: string | undefined; })[]; created_at: string; created_by: string; description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"date\" | \"text\" | \"keyword\" | \"ip\" | \"long\" | \"double\" | \"date_nanos\" | \"geo_point\" | \"geo_shape\" | \"short\" | \"binary\" | \"date_range\" | \"ip_range\" | \"shape\" | \"integer\" | \"byte\" | \"float\" | \"half_float\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; })[]; field: string; type: \"nested\"; })[]; id: string; item_id: string; list_id: string; meta: object | undefined; name: string; namespace_type: \"single\" | \"agnostic\"; os_types: (\"windows\" | \"linux\" | \"macos\")[]; tags: string[]; tie_breaker_id: string; type: \"simple\"; updated_at: string; updated_by: string; }[]; page: number; per_page: number; total: number; } | null>" + ") => Promise<{ data: { _version: string | undefined; comments: ({ comment: string; created_at: string; created_by: string; id: string; } & { updated_at?: string | undefined; updated_by?: string | undefined; })[]; created_at: string; created_by: string; description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"date\" | \"text\" | \"keyword\" | \"ip\" | \"long\" | \"double\" | \"date_nanos\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"short\" | \"date_range\" | \"ip_range\" | \"shape\" | \"integer\" | \"byte\" | \"float\" | \"half_float\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; })[]; field: string; type: \"nested\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; })[]; id: string; item_id: string; list_id: string; meta: object | undefined; name: string; namespace_type: \"single\" | \"agnostic\"; os_types: (\"windows\" | \"linux\" | \"macos\")[]; tags: string[]; tie_breaker_id: string; type: \"simple\"; updated_at: string; updated_by: string; }[]; page: number; per_page: number; total: number; } | null>" ], "description": [ "\nThis is the same as \"findExceptionList\" except it applies specifically to the endpoint list and will\nauto-call the \"createEndpointList\" for you so that you have the best chance of the endpoint\nbeing there if it did not exist before. If the list did not exist before, then creating it here should give you\na good guarantee that you will get an empty record set rather than null. I keep the null as the return value in\nthe off chance that you still might somehow not get into a race condition where the endpoint list does\nnot exist because someone deleted it in-between the initial create and then the find." @@ -2021,7 +2071,7 @@ "label": "findEndpointListItem", "source": { "path": "x-pack/plugins/lists/server/services/exception_lists/exception_list_client.ts", - "lineNumber": 464 + "lineNumber": 477 }, "tags": [], "returnComment": [] @@ -2029,7 +2079,7 @@ ], "source": { "path": "x-pack/plugins/lists/server/services/exception_lists/exception_list_client.ts", - "lineNumber": 56 + "lineNumber": 57 }, "initialIsOpen": false }, @@ -2125,7 +2175,7 @@ "signature": [ "({ id }: ", "GetListOptions", - ") => Promise<{ _version: string | undefined; created_at: string; created_by: string; description: string; deserializer: string | undefined; id: string; immutable: boolean; meta: object | undefined; name: string; serializer: string | undefined; tie_breaker_id: string; type: \"boolean\" | \"date\" | \"text\" | \"keyword\" | \"ip\" | \"long\" | \"double\" | \"date_nanos\" | \"geo_point\" | \"geo_shape\" | \"short\" | \"binary\" | \"date_range\" | \"ip_range\" | \"shape\" | \"integer\" | \"byte\" | \"float\" | \"half_float\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\"; updated_at: string; updated_by: string; version: number; } | null>" + ") => Promise<{ _version: string | undefined; created_at: string; created_by: string; description: string; deserializer: string | undefined; id: string; immutable: boolean; meta: object | undefined; name: string; serializer: string | undefined; tie_breaker_id: string; type: \"boolean\" | \"date\" | \"text\" | \"keyword\" | \"ip\" | \"long\" | \"double\" | \"date_nanos\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"short\" | \"date_range\" | \"ip_range\" | \"shape\" | \"integer\" | \"byte\" | \"float\" | \"half_float\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\"; updated_at: string; updated_by: string; version: number; } | null>" ], "description": [], "label": "getList", @@ -2158,7 +2208,7 @@ "signature": [ "({ id, deserializer, immutable, serializer, name, description, type, meta, version, }: ", "CreateListOptions", - ") => Promise<{ _version: string | undefined; created_at: string; created_by: string; description: string; deserializer: string | undefined; id: string; immutable: boolean; meta: object | undefined; name: string; serializer: string | undefined; tie_breaker_id: string; type: \"boolean\" | \"date\" | \"text\" | \"keyword\" | \"ip\" | \"long\" | \"double\" | \"date_nanos\" | \"geo_point\" | \"geo_shape\" | \"short\" | \"binary\" | \"date_range\" | \"ip_range\" | \"shape\" | \"integer\" | \"byte\" | \"float\" | \"half_float\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\"; updated_at: string; updated_by: string; version: number; }>" + ") => Promise<{ _version: string | undefined; created_at: string; created_by: string; description: string; deserializer: string | undefined; id: string; immutable: boolean; meta: object | undefined; name: string; serializer: string | undefined; tie_breaker_id: string; type: \"boolean\" | \"date\" | \"text\" | \"keyword\" | \"ip\" | \"long\" | \"double\" | \"date_nanos\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"short\" | \"date_range\" | \"ip_range\" | \"shape\" | \"integer\" | \"byte\" | \"float\" | \"half_float\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\"; updated_at: string; updated_by: string; version: number; }>" ], "description": [], "label": "createList", @@ -2191,7 +2241,7 @@ "signature": [ "({ id, deserializer, serializer, name, description, immutable, type, meta, version, }: ", "CreateListIfItDoesNotExistOptions", - ") => Promise<{ _version: string | undefined; created_at: string; created_by: string; description: string; deserializer: string | undefined; id: string; immutable: boolean; meta: object | undefined; name: string; serializer: string | undefined; tie_breaker_id: string; type: \"boolean\" | \"date\" | \"text\" | \"keyword\" | \"ip\" | \"long\" | \"double\" | \"date_nanos\" | \"geo_point\" | \"geo_shape\" | \"short\" | \"binary\" | \"date_range\" | \"ip_range\" | \"shape\" | \"integer\" | \"byte\" | \"float\" | \"half_float\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\"; updated_at: string; updated_by: string; version: number; }>" + ") => Promise<{ _version: string | undefined; created_at: string; created_by: string; description: string; deserializer: string | undefined; id: string; immutable: boolean; meta: object | undefined; name: string; serializer: string | undefined; tie_breaker_id: string; type: \"boolean\" | \"date\" | \"text\" | \"keyword\" | \"ip\" | \"long\" | \"double\" | \"date_nanos\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"short\" | \"date_range\" | \"ip_range\" | \"shape\" | \"integer\" | \"byte\" | \"float\" | \"half_float\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\"; updated_at: string; updated_by: string; version: number; }>" ], "description": [], "label": "createListIfItDoesNotExist", @@ -2544,7 +2594,7 @@ "signature": [ "({ id }: ", "DeleteListItemOptions", - ") => Promise<{ _version: string | undefined; created_at: string; created_by: string; deserializer: string | undefined; id: string; list_id: string; meta: object | undefined; serializer: string | undefined; tie_breaker_id: string; type: \"boolean\" | \"date\" | \"text\" | \"keyword\" | \"ip\" | \"long\" | \"double\" | \"date_nanos\" | \"geo_point\" | \"geo_shape\" | \"short\" | \"binary\" | \"date_range\" | \"ip_range\" | \"shape\" | \"integer\" | \"byte\" | \"float\" | \"half_float\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\"; updated_at: string; updated_by: string; value: string; } | null>" + ") => Promise<{ _version: string | undefined; created_at: string; created_by: string; deserializer: string | undefined; id: string; list_id: string; meta: object | undefined; serializer: string | undefined; tie_breaker_id: string; type: \"boolean\" | \"date\" | \"text\" | \"keyword\" | \"ip\" | \"long\" | \"double\" | \"date_nanos\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"short\" | \"date_range\" | \"ip_range\" | \"shape\" | \"integer\" | \"byte\" | \"float\" | \"half_float\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\"; updated_at: string; updated_by: string; value: string; } | null>" ], "description": [], "label": "deleteListItem", @@ -2577,7 +2627,7 @@ "signature": [ "({ listId, value, type, }: ", "DeleteListItemByValueOptions", - ") => Promise<{ _version: string | undefined; created_at: string; created_by: string; deserializer: string | undefined; id: string; list_id: string; meta: object | undefined; serializer: string | undefined; tie_breaker_id: string; type: \"boolean\" | \"date\" | \"text\" | \"keyword\" | \"ip\" | \"long\" | \"double\" | \"date_nanos\" | \"geo_point\" | \"geo_shape\" | \"short\" | \"binary\" | \"date_range\" | \"ip_range\" | \"shape\" | \"integer\" | \"byte\" | \"float\" | \"half_float\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\"; updated_at: string; updated_by: string; value: string; }[]>" + ") => Promise<{ _version: string | undefined; created_at: string; created_by: string; deserializer: string | undefined; id: string; list_id: string; meta: object | undefined; serializer: string | undefined; tie_breaker_id: string; type: \"boolean\" | \"date\" | \"text\" | \"keyword\" | \"ip\" | \"long\" | \"double\" | \"date_nanos\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"short\" | \"date_range\" | \"ip_range\" | \"shape\" | \"integer\" | \"byte\" | \"float\" | \"half_float\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\"; updated_at: string; updated_by: string; value: string; }[]>" ], "description": [], "label": "deleteListItemByValue", @@ -2610,7 +2660,7 @@ "signature": [ "({ id }: ", "DeleteListOptions", - ") => Promise<{ _version: string | undefined; created_at: string; created_by: string; description: string; deserializer: string | undefined; id: string; immutable: boolean; meta: object | undefined; name: string; serializer: string | undefined; tie_breaker_id: string; type: \"boolean\" | \"date\" | \"text\" | \"keyword\" | \"ip\" | \"long\" | \"double\" | \"date_nanos\" | \"geo_point\" | \"geo_shape\" | \"short\" | \"binary\" | \"date_range\" | \"ip_range\" | \"shape\" | \"integer\" | \"byte\" | \"float\" | \"half_float\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\"; updated_at: string; updated_by: string; version: number; } | null>" + ") => Promise<{ _version: string | undefined; created_at: string; created_by: string; description: string; deserializer: string | undefined; id: string; immutable: boolean; meta: object | undefined; name: string; serializer: string | undefined; tie_breaker_id: string; type: \"boolean\" | \"date\" | \"text\" | \"keyword\" | \"ip\" | \"long\" | \"double\" | \"date_nanos\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"short\" | \"date_range\" | \"ip_range\" | \"shape\" | \"integer\" | \"byte\" | \"float\" | \"half_float\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\"; updated_at: string; updated_by: string; version: number; } | null>" ], "description": [], "label": "deleteList", @@ -2676,7 +2726,7 @@ "signature": [ "({ deserializer, serializer, type, listId, stream, meta, version, }: ", "ImportListItemsToStreamOptions", - ") => Promise<{ _version: string | undefined; created_at: string; created_by: string; description: string; deserializer: string | undefined; id: string; immutable: boolean; meta: object | undefined; name: string; serializer: string | undefined; tie_breaker_id: string; type: \"boolean\" | \"date\" | \"text\" | \"keyword\" | \"ip\" | \"long\" | \"double\" | \"date_nanos\" | \"geo_point\" | \"geo_shape\" | \"short\" | \"binary\" | \"date_range\" | \"ip_range\" | \"shape\" | \"integer\" | \"byte\" | \"float\" | \"half_float\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\"; updated_at: string; updated_by: string; version: number; } | null>" + ") => Promise<{ _version: string | undefined; created_at: string; created_by: string; description: string; deserializer: string | undefined; id: string; immutable: boolean; meta: object | undefined; name: string; serializer: string | undefined; tie_breaker_id: string; type: \"boolean\" | \"date\" | \"text\" | \"keyword\" | \"ip\" | \"long\" | \"double\" | \"date_nanos\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"short\" | \"date_range\" | \"ip_range\" | \"shape\" | \"integer\" | \"byte\" | \"float\" | \"half_float\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\"; updated_at: string; updated_by: string; version: number; } | null>" ], "description": [], "label": "importListItemsToStream", @@ -2709,7 +2759,7 @@ "signature": [ "({ listId, value, type, }: ", "GetListItemByValueOptions", - ") => Promise<{ _version: string | undefined; created_at: string; created_by: string; deserializer: string | undefined; id: string; list_id: string; meta: object | undefined; serializer: string | undefined; tie_breaker_id: string; type: \"boolean\" | \"date\" | \"text\" | \"keyword\" | \"ip\" | \"long\" | \"double\" | \"date_nanos\" | \"geo_point\" | \"geo_shape\" | \"short\" | \"binary\" | \"date_range\" | \"ip_range\" | \"shape\" | \"integer\" | \"byte\" | \"float\" | \"half_float\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\"; updated_at: string; updated_by: string; value: string; }[]>" + ") => Promise<{ _version: string | undefined; created_at: string; created_by: string; deserializer: string | undefined; id: string; list_id: string; meta: object | undefined; serializer: string | undefined; tie_breaker_id: string; type: \"boolean\" | \"date\" | \"text\" | \"keyword\" | \"ip\" | \"long\" | \"double\" | \"date_nanos\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"short\" | \"date_range\" | \"ip_range\" | \"shape\" | \"integer\" | \"byte\" | \"float\" | \"half_float\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\"; updated_at: string; updated_by: string; value: string; }[]>" ], "description": [], "label": "getListItemByValue", @@ -2742,7 +2792,7 @@ "signature": [ "({ id, deserializer, serializer, listId, value, type, meta, }: ", "CreateListItemOptions", - ") => Promise<{ _version: string | undefined; created_at: string; created_by: string; deserializer: string | undefined; id: string; list_id: string; meta: object | undefined; serializer: string | undefined; tie_breaker_id: string; type: \"boolean\" | \"date\" | \"text\" | \"keyword\" | \"ip\" | \"long\" | \"double\" | \"date_nanos\" | \"geo_point\" | \"geo_shape\" | \"short\" | \"binary\" | \"date_range\" | \"ip_range\" | \"shape\" | \"integer\" | \"byte\" | \"float\" | \"half_float\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\"; updated_at: string; updated_by: string; value: string; } | null>" + ") => Promise<{ _version: string | undefined; created_at: string; created_by: string; deserializer: string | undefined; id: string; list_id: string; meta: object | undefined; serializer: string | undefined; tie_breaker_id: string; type: \"boolean\" | \"date\" | \"text\" | \"keyword\" | \"ip\" | \"long\" | \"double\" | \"date_nanos\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"short\" | \"date_range\" | \"ip_range\" | \"shape\" | \"integer\" | \"byte\" | \"float\" | \"half_float\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\"; updated_at: string; updated_by: string; value: string; } | null>" ], "description": [], "label": "createListItem", @@ -2775,7 +2825,7 @@ "signature": [ "({ _version, id, value, meta, }: ", "UpdateListItemOptions", - ") => Promise<{ _version: string | undefined; created_at: string; created_by: string; deserializer: string | undefined; id: string; list_id: string; meta: object | undefined; serializer: string | undefined; tie_breaker_id: string; type: \"boolean\" | \"date\" | \"text\" | \"keyword\" | \"ip\" | \"long\" | \"double\" | \"date_nanos\" | \"geo_point\" | \"geo_shape\" | \"short\" | \"binary\" | \"date_range\" | \"ip_range\" | \"shape\" | \"integer\" | \"byte\" | \"float\" | \"half_float\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\"; updated_at: string; updated_by: string; value: string; } | null>" + ") => Promise<{ _version: string | undefined; created_at: string; created_by: string; deserializer: string | undefined; id: string; list_id: string; meta: object | undefined; serializer: string | undefined; tie_breaker_id: string; type: \"boolean\" | \"date\" | \"text\" | \"keyword\" | \"ip\" | \"long\" | \"double\" | \"date_nanos\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"short\" | \"date_range\" | \"ip_range\" | \"shape\" | \"integer\" | \"byte\" | \"float\" | \"half_float\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\"; updated_at: string; updated_by: string; value: string; } | null>" ], "description": [], "label": "updateListItem", @@ -2808,7 +2858,7 @@ "signature": [ "({ _version, id, name, description, meta, version, }: ", "UpdateListOptions", - ") => Promise<{ _version: string | undefined; created_at: string; created_by: string; description: string; deserializer: string | undefined; id: string; immutable: boolean; meta: object | undefined; name: string; serializer: string | undefined; tie_breaker_id: string; type: \"boolean\" | \"date\" | \"text\" | \"keyword\" | \"ip\" | \"long\" | \"double\" | \"date_nanos\" | \"geo_point\" | \"geo_shape\" | \"short\" | \"binary\" | \"date_range\" | \"ip_range\" | \"shape\" | \"integer\" | \"byte\" | \"float\" | \"half_float\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\"; updated_at: string; updated_by: string; version: number; } | null>" + ") => Promise<{ _version: string | undefined; created_at: string; created_by: string; description: string; deserializer: string | undefined; id: string; immutable: boolean; meta: object | undefined; name: string; serializer: string | undefined; tie_breaker_id: string; type: \"boolean\" | \"date\" | \"text\" | \"keyword\" | \"ip\" | \"long\" | \"double\" | \"date_nanos\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"short\" | \"date_range\" | \"ip_range\" | \"shape\" | \"integer\" | \"byte\" | \"float\" | \"half_float\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\"; updated_at: string; updated_by: string; version: number; } | null>" ], "description": [], "label": "updateList", @@ -2841,7 +2891,7 @@ "signature": [ "({ id }: ", "GetListItemOptions", - ") => Promise<{ _version: string | undefined; created_at: string; created_by: string; deserializer: string | undefined; id: string; list_id: string; meta: object | undefined; serializer: string | undefined; tie_breaker_id: string; type: \"boolean\" | \"date\" | \"text\" | \"keyword\" | \"ip\" | \"long\" | \"double\" | \"date_nanos\" | \"geo_point\" | \"geo_shape\" | \"short\" | \"binary\" | \"date_range\" | \"ip_range\" | \"shape\" | \"integer\" | \"byte\" | \"float\" | \"half_float\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\"; updated_at: string; updated_by: string; value: string; } | null>" + ") => Promise<{ _version: string | undefined; created_at: string; created_by: string; deserializer: string | undefined; id: string; list_id: string; meta: object | undefined; serializer: string | undefined; tie_breaker_id: string; type: \"boolean\" | \"date\" | \"text\" | \"keyword\" | \"ip\" | \"long\" | \"double\" | \"date_nanos\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"short\" | \"date_range\" | \"ip_range\" | \"shape\" | \"integer\" | \"byte\" | \"float\" | \"half_float\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\"; updated_at: string; updated_by: string; value: string; } | null>" ], "description": [], "label": "getListItem", @@ -2874,7 +2924,7 @@ "signature": [ "({ type, listId, value, }: ", "GetListItemsByValueOptions", - ") => Promise<{ _version: string | undefined; created_at: string; created_by: string; deserializer: string | undefined; id: string; list_id: string; meta: object | undefined; serializer: string | undefined; tie_breaker_id: string; type: \"boolean\" | \"date\" | \"text\" | \"keyword\" | \"ip\" | \"long\" | \"double\" | \"date_nanos\" | \"geo_point\" | \"geo_shape\" | \"short\" | \"binary\" | \"date_range\" | \"ip_range\" | \"shape\" | \"integer\" | \"byte\" | \"float\" | \"half_float\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\"; updated_at: string; updated_by: string; value: string; }[]>" + ") => Promise<{ _version: string | undefined; created_at: string; created_by: string; deserializer: string | undefined; id: string; list_id: string; meta: object | undefined; serializer: string | undefined; tie_breaker_id: string; type: \"boolean\" | \"date\" | \"text\" | \"keyword\" | \"ip\" | \"long\" | \"double\" | \"date_nanos\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"short\" | \"date_range\" | \"ip_range\" | \"shape\" | \"integer\" | \"byte\" | \"float\" | \"half_float\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\"; updated_at: string; updated_by: string; value: string; }[]>" ], "description": [], "label": "getListItemByValues", @@ -2907,7 +2957,7 @@ "signature": [ "({ type, listId, value, }: ", "SearchListItemByValuesOptions", - ") => Promise<{ items: { _version: string | undefined; created_at: string; created_by: string; deserializer: string | undefined; id: string; list_id: string; meta: object | undefined; serializer: string | undefined; tie_breaker_id: string; type: \"boolean\" | \"date\" | \"text\" | \"keyword\" | \"ip\" | \"long\" | \"double\" | \"date_nanos\" | \"geo_point\" | \"geo_shape\" | \"short\" | \"binary\" | \"date_range\" | \"ip_range\" | \"shape\" | \"integer\" | \"byte\" | \"float\" | \"half_float\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\"; updated_at: string; updated_by: string; value: string; }[]; value: unknown; }[]>" + ") => Promise<{ items: { _version: string | undefined; created_at: string; created_by: string; deserializer: string | undefined; id: string; list_id: string; meta: object | undefined; serializer: string | undefined; tie_breaker_id: string; type: \"boolean\" | \"date\" | \"text\" | \"keyword\" | \"ip\" | \"long\" | \"double\" | \"date_nanos\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"short\" | \"date_range\" | \"ip_range\" | \"shape\" | \"integer\" | \"byte\" | \"float\" | \"half_float\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\"; updated_at: string; updated_by: string; value: string; }[]; value: unknown; }[]>" ], "description": [], "label": "searchListItemByValues", @@ -2940,7 +2990,7 @@ "signature": [ "({ filter, currentIndexPosition, perPage, page, sortField, sortOrder, searchAfter, }: ", "FindListOptions", - ") => Promise<{ cursor: string; data: { _version: string | undefined; created_at: string; created_by: string; description: string; deserializer: string | undefined; id: string; immutable: boolean; meta: object | undefined; name: string; serializer: string | undefined; tie_breaker_id: string; type: \"boolean\" | \"date\" | \"text\" | \"keyword\" | \"ip\" | \"long\" | \"double\" | \"date_nanos\" | \"geo_point\" | \"geo_shape\" | \"short\" | \"binary\" | \"date_range\" | \"ip_range\" | \"shape\" | \"integer\" | \"byte\" | \"float\" | \"half_float\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\"; updated_at: string; updated_by: string; version: number; }[]; page: number; per_page: number; total: number; }>" + ") => Promise<{ cursor: string; data: { _version: string | undefined; created_at: string; created_by: string; description: string; deserializer: string | undefined; id: string; immutable: boolean; meta: object | undefined; name: string; serializer: string | undefined; tie_breaker_id: string; type: \"boolean\" | \"date\" | \"text\" | \"keyword\" | \"ip\" | \"long\" | \"double\" | \"date_nanos\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"short\" | \"date_range\" | \"ip_range\" | \"shape\" | \"integer\" | \"byte\" | \"float\" | \"half_float\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\"; updated_at: string; updated_by: string; version: number; }[]; page: number; per_page: number; total: number; }>" ], "description": [], "label": "findList", @@ -2973,7 +3023,7 @@ "signature": [ "({ listId, filter, currentIndexPosition, perPage, page, sortField, sortOrder, searchAfter, }: ", "FindListItemOptions", - ") => Promise<{ cursor: string; data: { _version: string | undefined; created_at: string; created_by: string; deserializer: string | undefined; id: string; list_id: string; meta: object | undefined; serializer: string | undefined; tie_breaker_id: string; type: \"boolean\" | \"date\" | \"text\" | \"keyword\" | \"ip\" | \"long\" | \"double\" | \"date_nanos\" | \"geo_point\" | \"geo_shape\" | \"short\" | \"binary\" | \"date_range\" | \"ip_range\" | \"shape\" | \"integer\" | \"byte\" | \"float\" | \"half_float\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\"; updated_at: string; updated_by: string; value: string; }[]; page: number; per_page: number; total: number; } | null>" + ") => Promise<{ cursor: string; data: { _version: string | undefined; created_at: string; created_by: string; deserializer: string | undefined; id: string; list_id: string; meta: object | undefined; serializer: string | undefined; tie_breaker_id: string; type: \"boolean\" | \"date\" | \"text\" | \"keyword\" | \"ip\" | \"long\" | \"double\" | \"date_nanos\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"short\" | \"date_range\" | \"ip_range\" | \"shape\" | \"integer\" | \"byte\" | \"float\" | \"half_float\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\"; updated_at: string; updated_by: string; value: string; }[]; page: number; per_page: number; total: number; } | null>" ], "description": [], "label": "findListItem", @@ -3026,7 +3076,7 @@ "lineNumber": 119 }, "signature": [ - "({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"date\" | \"text\" | \"keyword\" | \"ip\" | \"long\" | \"double\" | \"date_nanos\" | \"geo_point\" | \"geo_shape\" | \"short\" | \"binary\" | \"date_range\" | \"ip_range\" | \"shape\" | \"integer\" | \"byte\" | \"float\" | \"half_float\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; })[]; field: string; type: \"nested\"; })[]" + "({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"date\" | \"text\" | \"keyword\" | \"ip\" | \"long\" | \"double\" | \"date_nanos\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"short\" | \"date_range\" | \"ip_range\" | \"shape\" | \"integer\" | \"byte\" | \"float\" | \"half_float\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; })[]; field: string; type: \"nested\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; })[]" ] }, { @@ -3296,7 +3346,7 @@ "lineNumber": 146 }, "signature": [ - "({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"date\" | \"text\" | \"keyword\" | \"ip\" | \"long\" | \"double\" | \"date_nanos\" | \"geo_point\" | \"geo_shape\" | \"short\" | \"binary\" | \"date_range\" | \"ip_range\" | \"shape\" | \"integer\" | \"byte\" | \"float\" | \"half_float\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; })[]; field: string; type: \"nested\"; })[]" + "({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"date\" | \"text\" | \"keyword\" | \"ip\" | \"long\" | \"double\" | \"date_nanos\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"short\" | \"date_range\" | \"ip_range\" | \"shape\" | \"integer\" | \"byte\" | \"float\" | \"half_float\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; })[]; field: string; type: \"nested\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; })[]" ] }, { @@ -3462,7 +3512,7 @@ "lineNumber": 74 }, "signature": [ - "(({ description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"date\" | \"text\" | \"keyword\" | \"ip\" | \"long\" | \"double\" | \"date_nanos\" | \"geo_point\" | \"geo_shape\" | \"short\" | \"binary\" | \"date_range\" | \"ip_range\" | \"shape\" | \"integer\" | \"byte\" | \"float\" | \"half_float\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; })[]; field: string; type: \"nested\"; })[]; list_id: string; name: string; type: \"simple\"; } & { comments?: { comment: string; }[] | undefined; item_id?: string | undefined; meta?: object | undefined; namespace_type?: \"single\" | \"agnostic\" | undefined; os_types?: (\"windows\" | \"linux\" | \"macos\")[] | undefined; tags?: string[] | undefined; }) | { _version: string | undefined; comments: ({ comment: string; created_at: string; created_by: string; id: string; } & { updated_at?: string | undefined; updated_by?: string | undefined; })[]; created_at: string; created_by: string; description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"date\" | \"text\" | \"keyword\" | \"ip\" | \"long\" | \"double\" | \"date_nanos\" | \"geo_point\" | \"geo_shape\" | \"short\" | \"binary\" | \"date_range\" | \"ip_range\" | \"shape\" | \"integer\" | \"byte\" | \"float\" | \"half_float\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; })[]; field: string; type: \"nested\"; })[]; id: string; item_id: string; list_id: string; meta: object | undefined; name: string; namespace_type: \"single\" | \"agnostic\"; os_types: (\"windows\" | \"linux\" | \"macos\")[]; tags: string[]; tie_breaker_id: string; type: \"simple\"; updated_at: string; updated_by: string; })[]" + "(({ description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"date\" | \"text\" | \"keyword\" | \"ip\" | \"long\" | \"double\" | \"date_nanos\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"short\" | \"date_range\" | \"ip_range\" | \"shape\" | \"integer\" | \"byte\" | \"float\" | \"half_float\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; })[]; field: string; type: \"nested\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; })[]; list_id: string; name: string; type: \"simple\"; } & { comments?: { comment: string; }[] | undefined; item_id?: string | undefined; meta?: object | undefined; namespace_type?: \"single\" | \"agnostic\" | undefined; os_types?: (\"windows\" | \"linux\" | \"macos\")[] | undefined; tags?: string[] | undefined; }) | { _version: string | undefined; comments: ({ comment: string; created_at: string; created_by: string; id: string; } & { updated_at?: string | undefined; updated_by?: string | undefined; })[]; created_at: string; created_by: string; description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"date\" | \"text\" | \"keyword\" | \"ip\" | \"long\" | \"double\" | \"date_nanos\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"short\" | \"date_range\" | \"ip_range\" | \"shape\" | \"integer\" | \"byte\" | \"float\" | \"half_float\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; })[]; field: string; type: \"nested\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; })[]; id: string; item_id: string; list_id: string; meta: object | undefined; name: string; namespace_type: \"single\" | \"agnostic\"; os_types: (\"windows\" | \"linux\" | \"macos\")[]; tags: string[]; tie_breaker_id: string; type: \"simple\"; updated_at: string; updated_by: string; })[]" ] }, { @@ -3495,7 +3545,7 @@ } ], "signature": [ - "({ lists, excludeExceptions, chunkSize, }: { lists: (({ description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"date\" | \"text\" | \"keyword\" | \"ip\" | \"long\" | \"double\" | \"date_nanos\" | \"geo_point\" | \"geo_shape\" | \"short\" | \"binary\" | \"date_range\" | \"ip_range\" | \"shape\" | \"integer\" | \"byte\" | \"float\" | \"half_float\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; })[]; field: string; type: \"nested\"; })[]; list_id: string; name: string; type: \"simple\"; } & { comments?: { comment: string; }[] | undefined; item_id?: string | undefined; meta?: object | undefined; namespace_type?: \"single\" | \"agnostic\" | undefined; os_types?: (\"windows\" | \"linux\" | \"macos\")[] | undefined; tags?: string[] | undefined; }) | { _version: string | undefined; comments: ({ comment: string; created_at: string; created_by: string; id: string; } & { updated_at?: string | undefined; updated_by?: string | undefined; })[]; created_at: string; created_by: string; description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"date\" | \"text\" | \"keyword\" | \"ip\" | \"long\" | \"double\" | \"date_nanos\" | \"geo_point\" | \"geo_shape\" | \"short\" | \"binary\" | \"date_range\" | \"ip_range\" | \"shape\" | \"integer\" | \"byte\" | \"float\" | \"half_float\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; })[]; field: string; type: \"nested\"; })[]; id: string; item_id: string; list_id: string; meta: object | undefined; name: string; namespace_type: \"single\" | \"agnostic\"; os_types: (\"windows\" | \"linux\" | \"macos\")[]; tags: string[]; tie_breaker_id: string; type: \"simple\"; updated_at: string; updated_by: string; })[]; excludeExceptions: boolean; chunkSize: number; }) => ", + "({ lists, excludeExceptions, chunkSize, }: { lists: (({ description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"date\" | \"text\" | \"keyword\" | \"ip\" | \"long\" | \"double\" | \"date_nanos\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"short\" | \"date_range\" | \"ip_range\" | \"shape\" | \"integer\" | \"byte\" | \"float\" | \"half_float\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; })[]; field: string; type: \"nested\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; })[]; list_id: string; name: string; type: \"simple\"; } & { comments?: { comment: string; }[] | undefined; item_id?: string | undefined; meta?: object | undefined; namespace_type?: \"single\" | \"agnostic\" | undefined; os_types?: (\"windows\" | \"linux\" | \"macos\")[] | undefined; tags?: string[] | undefined; }) | { _version: string | undefined; comments: ({ comment: string; created_at: string; created_by: string; id: string; } & { updated_at?: string | undefined; updated_by?: string | undefined; })[]; created_at: string; created_by: string; description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"date\" | \"text\" | \"keyword\" | \"ip\" | \"long\" | \"double\" | \"date_nanos\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"short\" | \"date_range\" | \"ip_range\" | \"shape\" | \"integer\" | \"byte\" | \"float\" | \"half_float\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; })[]; field: string; type: \"nested\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; })[]; id: string; item_id: string; list_id: string; meta: object | undefined; name: string; namespace_type: \"single\" | \"agnostic\"; os_types: (\"windows\" | \"linux\" | \"macos\")[]; tags: string[]; tie_breaker_id: string; type: \"simple\"; updated_at: string; updated_by: string; })[]; excludeExceptions: boolean; chunkSize: number; }) => ", { "pluginId": "data", "scope": "common", @@ -3522,11 +3572,13 @@ "id": "def-common.ExceptionListTypeEnum", "type": "Enum", "label": "ExceptionListTypeEnum", - "tags": [], + "tags": [ + "deprecated" + ], "description": [], "source": { "path": "x-pack/plugins/lists/common/schemas/common/schemas.ts", - "lineNumber": 223 + "lineNumber": 337 }, "initialIsOpen": false }, @@ -3534,11 +3586,13 @@ "id": "def-common.OperatorEnum", "type": "Enum", "label": "OperatorEnum", - "tags": [], + "tags": [ + "deprecated" + ], "description": [], "source": { "path": "x-pack/plugins/lists/common/schemas/common/schemas.ts", - "lineNumber": 281 + "lineNumber": 425 }, "initialIsOpen": false }, @@ -3546,11 +3600,13 @@ "id": "def-common.OperatorTypeEnum", "type": "Enum", "label": "OperatorTypeEnum", - "tags": [], + "tags": [ + "deprecated" + ], "description": [], "source": { "path": "x-pack/plugins/lists/common/schemas/common/schemas.ts", - "lineNumber": 286 + "lineNumber": 433 }, "initialIsOpen": false } @@ -3560,11 +3616,13 @@ "id": "def-common.Comment", "type": "Type", "label": "Comment", - "tags": [], + "tags": [ + "deprecated" + ], "description": [], "source": { "path": "x-pack/plugins/lists/common/schemas/types/comment.ts", - "lineNumber": 32 + "lineNumber": 46 }, "signature": [ "{ comment: string; created_at: string; created_by: string; id: string; } & { updated_at?: string | undefined; updated_by?: string | undefined; }" @@ -3575,11 +3633,13 @@ "id": "def-common.CommentsArray", "type": "Type", "label": "CommentsArray", - "tags": [], + "tags": [ + "deprecated" + ], "description": [], "source": { "path": "x-pack/plugins/lists/common/schemas/types/comment.ts", - "lineNumber": 31 + "lineNumber": 41 }, "signature": [ "({ comment: string; created_at: string; created_by: string; id: string; } & { updated_at?: string | undefined; updated_by?: string | undefined; })[]" @@ -3590,11 +3650,13 @@ "id": "def-common.CreateComment", "type": "Type", "label": "CreateComment", - "tags": [], + "tags": [ + "deprecated" + ], "description": [], "source": { "path": "x-pack/plugins/lists/common/schemas/types/create_comment.ts", - "lineNumber": 18 + "lineNumber": 24 }, "signature": [ "{ comment: string; }" @@ -3605,11 +3667,13 @@ "id": "def-common.CreateCommentsArray", "type": "Type", "label": "CreateCommentsArray", - "tags": [], + "tags": [ + "deprecated" + ], "description": [], "source": { "path": "x-pack/plugins/lists/common/schemas/types/create_comment.ts", - "lineNumber": 20 + "lineNumber": 34 }, "signature": [ "{ comment: string; }[]" @@ -3627,7 +3691,7 @@ "lineNumber": 55 }, "signature": [ - "{ description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"date\" | \"text\" | \"keyword\" | \"ip\" | \"long\" | \"double\" | \"date_nanos\" | \"geo_point\" | \"geo_shape\" | \"short\" | \"binary\" | \"date_range\" | \"ip_range\" | \"shape\" | \"integer\" | \"byte\" | \"float\" | \"half_float\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; })[]; field: string; type: \"nested\"; })[]; list_id: string; name: string; type: \"simple\"; } & { comments?: { comment: string; }[] | undefined; item_id?: string | undefined; meta?: object | undefined; namespace_type?: \"single\" | \"agnostic\" | undefined; os_types?: (\"windows\" | \"linux\" | \"macos\")[] | undefined; tags?: string[] | undefined; }" + "{ description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"date\" | \"text\" | \"keyword\" | \"ip\" | \"long\" | \"double\" | \"date_nanos\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"short\" | \"date_range\" | \"ip_range\" | \"shape\" | \"integer\" | \"byte\" | \"float\" | \"half_float\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; })[]; field: string; type: \"nested\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; })[]; list_id: string; name: string; type: \"simple\"; } & { comments?: { comment: string; }[] | undefined; item_id?: string | undefined; meta?: object | undefined; namespace_type?: \"single\" | \"agnostic\" | undefined; os_types?: (\"windows\" | \"linux\" | \"macos\")[] | undefined; tags?: string[] | undefined; }" ], "initialIsOpen": false }, @@ -3646,6 +3710,57 @@ ], "initialIsOpen": false }, + { + "tags": [], + "id": "def-common.ENDPOINT_EVENT_FILTERS_LIST_DESCRIPTION", + "type": "string", + "label": "ENDPOINT_EVENT_FILTERS_LIST_DESCRIPTION", + "description": [ + "Description of event filters agnostic list" + ], + "source": { + "path": "x-pack/plugins/lists/common/constants.ts", + "lineNumber": 71 + }, + "signature": [ + "\"Endpoint Security Event Filters List\"" + ], + "initialIsOpen": false + }, + { + "tags": [], + "id": "def-common.ENDPOINT_EVENT_FILTERS_LIST_ID", + "type": "string", + "label": "ENDPOINT_EVENT_FILTERS_LIST_ID", + "description": [ + "ID of event filters agnostic list" + ], + "source": { + "path": "x-pack/plugins/lists/common/constants.ts", + "lineNumber": 65 + }, + "signature": [ + "\"endpoint_event_filters\"" + ], + "initialIsOpen": false + }, + { + "tags": [], + "id": "def-common.ENDPOINT_EVENT_FILTERS_LIST_NAME", + "type": "string", + "label": "ENDPOINT_EVENT_FILTERS_LIST_NAME", + "description": [ + "Name of event filters agnostic list" + ], + "source": { + "path": "x-pack/plugins/lists/common/constants.ts", + "lineNumber": 68 + }, + "signature": [ + "\"Endpoint Security Event Filters List\"" + ], + "initialIsOpen": false + }, { "tags": [], "id": "def-common.ENDPOINT_LIST_ID", @@ -3684,14 +3799,16 @@ "id": "def-common.EntriesArray", "type": "Type", "label": "EntriesArray", - "tags": [], + "tags": [ + "deprecated" + ], "description": [], "source": { "path": "x-pack/plugins/lists/common/schemas/types/entries.ts", - "lineNumber": 22 + "lineNumber": 53 }, "signature": [ - "({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"date\" | \"text\" | \"keyword\" | \"ip\" | \"long\" | \"double\" | \"date_nanos\" | \"geo_point\" | \"geo_shape\" | \"short\" | \"binary\" | \"date_range\" | \"ip_range\" | \"shape\" | \"integer\" | \"byte\" | \"float\" | \"half_float\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; })[]; field: string; type: \"nested\"; })[]" + "({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"date\" | \"text\" | \"keyword\" | \"ip\" | \"long\" | \"double\" | \"date_nanos\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"short\" | \"date_range\" | \"ip_range\" | \"shape\" | \"integer\" | \"byte\" | \"float\" | \"half_float\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; })[]; field: string; type: \"nested\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; })[]" ], "initialIsOpen": false }, @@ -3699,14 +3816,16 @@ "id": "def-common.Entry", "type": "Type", "label": "Entry", - "tags": [], + "tags": [ + "deprecated" + ], "description": [], "source": { "path": "x-pack/plugins/lists/common/schemas/types/entries.ts", - "lineNumber": 17 + "lineNumber": 34 }, "signature": [ - "{ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"date\" | \"text\" | \"keyword\" | \"ip\" | \"long\" | \"double\" | \"date_nanos\" | \"geo_point\" | \"geo_shape\" | \"short\" | \"binary\" | \"date_range\" | \"ip_range\" | \"shape\" | \"integer\" | \"byte\" | \"float\" | \"half_float\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; }" + "{ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"date\" | \"text\" | \"keyword\" | \"ip\" | \"long\" | \"double\" | \"date_nanos\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"short\" | \"date_range\" | \"ip_range\" | \"shape\" | \"integer\" | \"byte\" | \"float\" | \"half_float\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; }" ], "initialIsOpen": false }, @@ -3714,11 +3833,13 @@ "id": "def-common.EntryExists", "type": "Type", "label": "EntryExists", - "tags": [], + "tags": [ + "deprecated" + ], "description": [], "source": { "path": "x-pack/plugins/lists/common/schemas/types/entry_exists.ts", - "lineNumber": 20 + "lineNumber": 27 }, "signature": [ "{ field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; }" @@ -3729,14 +3850,16 @@ "id": "def-common.EntryList", "type": "Type", "label": "EntryList", - "tags": [], + "tags": [ + "deprecated" + ], "description": [], "source": { "path": "x-pack/plugins/lists/common/schemas/types/entry_list.ts", - "lineNumber": 21 + "lineNumber": 28 }, "signature": [ - "{ field: string; list: { id: string; type: \"boolean\" | \"date\" | \"text\" | \"keyword\" | \"ip\" | \"long\" | \"double\" | \"date_nanos\" | \"geo_point\" | \"geo_shape\" | \"short\" | \"binary\" | \"date_range\" | \"ip_range\" | \"shape\" | \"integer\" | \"byte\" | \"float\" | \"half_float\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; }" + "{ field: string; list: { id: string; type: \"boolean\" | \"date\" | \"text\" | \"keyword\" | \"ip\" | \"long\" | \"double\" | \"date_nanos\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"short\" | \"date_range\" | \"ip_range\" | \"shape\" | \"integer\" | \"byte\" | \"float\" | \"half_float\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; }" ], "initialIsOpen": false }, @@ -3744,11 +3867,13 @@ "id": "def-common.EntryMatch", "type": "Type", "label": "EntryMatch", - "tags": [], + "tags": [ + "deprecated" + ], "description": [], "source": { "path": "x-pack/plugins/lists/common/schemas/types/entry_match.ts", - "lineNumber": 21 + "lineNumber": 28 }, "signature": [ "{ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; }" @@ -3759,32 +3884,85 @@ "id": "def-common.EntryMatchAny", "type": "Type", "label": "EntryMatchAny", - "tags": [], + "tags": [ + "deprecated" + ], "description": [], "source": { "path": "x-pack/plugins/lists/common/schemas/types/entry_match_any.ts", - "lineNumber": 23 + "lineNumber": 30 }, "signature": [ "{ field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; }" ], "initialIsOpen": false }, + { + "id": "def-common.EntryMatchWildcard", + "type": "Type", + "label": "EntryMatchWildcard", + "tags": [ + "deprecated" + ], + "description": [], + "source": { + "path": "x-pack/plugins/lists/common/schemas/types/entry_match_wildcard.ts", + "lineNumber": 28 + }, + "signature": [ + "{ field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; }" + ], + "initialIsOpen": false + }, { "id": "def-common.EntryNested", "type": "Type", "label": "EntryNested", - "tags": [], + "tags": [ + "deprecated" + ], "description": [], "source": { "path": "x-pack/plugins/lists/common/schemas/types/entry_nested.ts", - "lineNumber": 21 + "lineNumber": 28 }, "signature": [ "{ entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; })[]; field: string; type: \"nested\"; }" ], "initialIsOpen": false }, + { + "tags": [], + "id": "def-common.EXCEPTION_LIST_ITEM_URL", + "type": "string", + "label": "EXCEPTION_LIST_ITEM_URL", + "description": [], + "source": { + "path": "x-pack/plugins/lists/common/constants.ts", + "lineNumber": 20 + }, + "signature": [ + "\"/api/exception_lists/items\"" + ], + "initialIsOpen": false + }, + { + "tags": [], + "id": "def-common.EXCEPTION_LIST_URL", + "type": "string", + "label": "EXCEPTION_LIST_URL", + "description": [ + "\nException list routes" + ], + "source": { + "path": "x-pack/plugins/lists/common/constants.ts", + "lineNumber": 19 + }, + "signature": [ + "\"/api/exception_lists\"" + ], + "initialIsOpen": false + }, { "id": "def-common.ExceptionListItemSchema", "type": "Type", @@ -3796,7 +3974,7 @@ "lineNumber": 53 }, "signature": [ - "{ _version: string | undefined; comments: ({ comment: string; created_at: string; created_by: string; id: string; } & { updated_at?: string | undefined; updated_by?: string | undefined; })[]; created_at: string; created_by: string; description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"date\" | \"text\" | \"keyword\" | \"ip\" | \"long\" | \"double\" | \"date_nanos\" | \"geo_point\" | \"geo_shape\" | \"short\" | \"binary\" | \"date_range\" | \"ip_range\" | \"shape\" | \"integer\" | \"byte\" | \"float\" | \"half_float\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; })[]; field: string; type: \"nested\"; })[]; id: string; item_id: string; list_id: string; meta: object | undefined; name: string; namespace_type: \"single\" | \"agnostic\"; os_types: (\"windows\" | \"linux\" | \"macos\")[]; tags: string[]; tie_breaker_id: string; type: \"simple\"; updated_at: string; updated_by: string; }" + "{ _version: string | undefined; comments: ({ comment: string; created_at: string; created_by: string; id: string; } & { updated_at?: string | undefined; updated_by?: string | undefined; })[]; created_at: string; created_by: string; description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"date\" | \"text\" | \"keyword\" | \"ip\" | \"long\" | \"double\" | \"date_nanos\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"short\" | \"date_range\" | \"ip_range\" | \"shape\" | \"integer\" | \"byte\" | \"float\" | \"half_float\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; })[]; field: string; type: \"nested\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; })[]; id: string; item_id: string; list_id: string; meta: object | undefined; name: string; namespace_type: \"single\" | \"agnostic\"; os_types: (\"windows\" | \"linux\" | \"macos\")[]; tags: string[]; tie_breaker_id: string; type: \"simple\"; updated_at: string; updated_by: string; }" ], "initialIsOpen": false }, @@ -3819,11 +3997,13 @@ "id": "def-common.ExceptionListType", "type": "Type", "label": "ExceptionListType", - "tags": [], + "tags": [ + "deprecated" + ], "description": [], "source": { "path": "x-pack/plugins/lists/common/schemas/common/schemas.ts", - "lineNumber": 221 + "lineNumber": 327 }, "signature": [ "\"endpoint\" | \"detection\" | \"endpoint_events\"" @@ -3841,7 +4021,7 @@ "lineNumber": 48 }, "signature": [ - "{ _version: string | undefined; created_at: string; created_by: string; description: string; deserializer: string | undefined; id: string; immutable: boolean; meta: object | undefined; name: string; serializer: string | undefined; tie_breaker_id: string; type: \"boolean\" | \"date\" | \"text\" | \"keyword\" | \"ip\" | \"long\" | \"double\" | \"date_nanos\" | \"geo_point\" | \"geo_shape\" | \"short\" | \"binary\" | \"date_range\" | \"ip_range\" | \"shape\" | \"integer\" | \"byte\" | \"float\" | \"half_float\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\"; updated_at: string; updated_by: string; version: number; }" + "{ _version: string | undefined; created_at: string; created_by: string; description: string; deserializer: string | undefined; id: string; immutable: boolean; meta: object | undefined; name: string; serializer: string | undefined; tie_breaker_id: string; type: \"boolean\" | \"date\" | \"text\" | \"keyword\" | \"ip\" | \"long\" | \"double\" | \"date_nanos\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"short\" | \"date_range\" | \"ip_range\" | \"shape\" | \"integer\" | \"byte\" | \"float\" | \"half_float\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\"; updated_at: string; updated_by: string; version: number; }" ], "initialIsOpen": false }, @@ -3879,11 +4059,13 @@ "id": "def-common.Operator", "type": "Type", "label": "Operator", - "tags": [], + "tags": [ + "deprecated" + ], "description": [], "source": { "path": "x-pack/plugins/lists/common/schemas/common/schemas.ts", - "lineNumber": 280 + "lineNumber": 420 }, "signature": [ "\"excluded\" | \"included\"" @@ -3894,11 +4076,13 @@ "id": "def-common.OsTypeArray", "type": "Type", "label": "OsTypeArray", - "tags": [], + "tags": [ + "deprecated" + ], "description": [], "source": { "path": "x-pack/plugins/lists/common/schemas/common/schemas.ts", - "lineNumber": 330 + "lineNumber": 492 }, "signature": [ "(\"windows\" | \"linux\" | \"macos\")[]" @@ -3913,10 +4097,10 @@ "description": [], "source": { "path": "x-pack/plugins/lists/common/schemas/common/schemas.ts", - "lineNumber": 123 + "lineNumber": 188 }, "signature": [ - "\"boolean\" | \"date\" | \"text\" | \"keyword\" | \"ip\" | \"long\" | \"double\" | \"date_nanos\" | \"geo_point\" | \"geo_shape\" | \"short\" | \"binary\" | \"date_range\" | \"ip_range\" | \"shape\" | \"integer\" | \"byte\" | \"float\" | \"half_float\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\"" + "\"boolean\" | \"date\" | \"text\" | \"keyword\" | \"ip\" | \"long\" | \"double\" | \"date_nanos\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"short\" | \"date_range\" | \"ip_range\" | \"shape\" | \"integer\" | \"byte\" | \"float\" | \"half_float\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\"" ], "initialIsOpen": false }, @@ -3931,21 +4115,23 @@ "lineNumber": 55 }, "signature": [ - "{ description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"date\" | \"text\" | \"keyword\" | \"ip\" | \"long\" | \"double\" | \"date_nanos\" | \"geo_point\" | \"geo_shape\" | \"short\" | \"binary\" | \"date_range\" | \"ip_range\" | \"shape\" | \"integer\" | \"byte\" | \"float\" | \"half_float\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; })[]; field: string; type: \"nested\"; })[]; name: string; type: \"simple\"; } & { _version?: string | undefined; comments?: ({ comment: string; } & { id?: string | undefined; })[] | undefined; id?: string | undefined; item_id?: string | undefined; meta?: object | undefined; namespace_type?: \"single\" | \"agnostic\" | undefined; os_types?: (\"windows\" | \"linux\" | \"macos\")[] | undefined; tags?: string[] | undefined; }" + "{ description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"date\" | \"text\" | \"keyword\" | \"ip\" | \"long\" | \"double\" | \"date_nanos\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"short\" | \"date_range\" | \"ip_range\" | \"shape\" | \"integer\" | \"byte\" | \"float\" | \"half_float\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; })[]; field: string; type: \"nested\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; })[]; name: string; type: \"simple\"; } & { _version?: string | undefined; comments?: ({ comment: string; } & { id?: string | undefined; })[] | undefined; id?: string | undefined; item_id?: string | undefined; meta?: object | undefined; namespace_type?: \"single\" | \"agnostic\" | undefined; os_types?: (\"windows\" | \"linux\" | \"macos\")[] | undefined; tags?: string[] | undefined; }" ], "initialIsOpen": false } ], "objects": [ { - "tags": [], + "tags": [ + "deprecated" + ], "id": "def-common.comment", "type": "Object", "label": "comment", "description": [], "source": { "path": "x-pack/plugins/lists/common/schemas/types/comment.ts", - "lineNumber": 13 + "lineNumber": 16 }, "signature": [ "IntersectionC", @@ -3984,14 +4170,16 @@ "initialIsOpen": false }, { - "tags": [], + "tags": [ + "deprecated" + ], "id": "def-common.entriesExists", "type": "Object", "label": "entriesExists", "description": [], "source": { "path": "x-pack/plugins/lists/common/schemas/types/entry_exists.ts", - "lineNumber": 13 + "lineNumber": 16 }, "signature": [ "ExactC", @@ -4007,14 +4195,16 @@ "initialIsOpen": false }, { - "tags": [], + "tags": [ + "deprecated" + ], "id": "def-common.entriesList", "type": "Object", "label": "entriesList", "description": [], "source": { "path": "x-pack/plugins/lists/common/schemas/types/entry_list.ts", - "lineNumber": 13 + "lineNumber": 16 }, "signature": [ "ExactC", @@ -4030,14 +4220,16 @@ "initialIsOpen": false }, { - "tags": [], + "tags": [ + "deprecated" + ], "id": "def-common.entriesMatch", "type": "Object", "label": "entriesMatch", "description": [], "source": { "path": "x-pack/plugins/lists/common/schemas/types/entry_match.ts", - "lineNumber": 13 + "lineNumber": 16 }, "signature": [ "ExactC", @@ -4053,14 +4245,16 @@ "initialIsOpen": false }, { - "tags": [], + "tags": [ + "deprecated" + ], "id": "def-common.entriesMatchAny", "type": "Object", "label": "entriesMatchAny", "description": [], "source": { "path": "x-pack/plugins/lists/common/schemas/types/entry_match_any.ts", - "lineNumber": 15 + "lineNumber": 18 }, "signature": [ "ExactC", @@ -4076,14 +4270,41 @@ "initialIsOpen": false }, { - "tags": [], + "tags": [ + "deprecated" + ], + "id": "def-common.entriesMatchWildcard", + "type": "Object", + "label": "entriesMatchWildcard", + "description": [], + "source": { + "path": "x-pack/plugins/lists/common/schemas/types/entry_match_wildcard.ts", + "lineNumber": 16 + }, + "signature": [ + "ExactC", + "<", + "TypeC", + "<{ field: ", + "Type", + "; operator: ", + "KeyofC", + "<{ excluded: null; included: null; }>; type: ", + "KeyofC" + ], + "initialIsOpen": false + }, + { + "tags": [ + "deprecated" + ], "id": "def-common.entriesNested", "type": "Object", "label": "entriesNested", "description": [], "source": { "path": "x-pack/plugins/lists/common/schemas/types/entry_nested.ts", - "lineNumber": 14 + "lineNumber": 17 }, "signature": [ "ExactC", @@ -4099,14 +4320,16 @@ "initialIsOpen": false }, { - "tags": [], + "tags": [ + "deprecated" + ], "id": "def-common.entry", "type": "Object", "label": "entry", "description": [], "source": { "path": "x-pack/plugins/lists/common/schemas/types/entries.ts", - "lineNumber": 16 + "lineNumber": 23 }, "signature": [ "UnionC", @@ -4145,14 +4368,16 @@ "initialIsOpen": false }, { - "tags": [], + "tags": [ + "deprecated" + ], "id": "def-common.exceptionListType", "type": "Object", "label": "exceptionListType", "description": [], "source": { "path": "x-pack/plugins/lists/common/schemas/common/schemas.ts", - "lineNumber": 215 + "lineNumber": 313 }, "signature": [ "KeyofC", @@ -4223,14 +4448,16 @@ "initialIsOpen": false }, { - "tags": [], + "tags": [ + "deprecated" + ], "id": "def-common.osType", "type": "Object", "label": "osType", "description": [], "source": { "path": "x-pack/plugins/lists/common/schemas/common/schemas.ts", - "lineNumber": 322 + "lineNumber": 473 }, "signature": [ "KeyofC", @@ -4239,14 +4466,16 @@ "initialIsOpen": false }, { - "tags": [], + "tags": [ + "deprecated" + ], "id": "def-common.osTypeArray", "type": "Object", "label": "osTypeArray", "description": [], "source": { "path": "x-pack/plugins/lists/common/schemas/common/schemas.ts", - "lineNumber": 329 + "lineNumber": 487 }, "signature": [ "Type", diff --git a/api_docs/maps.json b/api_docs/maps.json index fca5e82bc0e1e..8f42ec8fb6f0d 100644 --- a/api_docs/maps.json +++ b/api_docs/maps.json @@ -33,7 +33,13 @@ "text": "MapEmbeddableInput" }, ", ", - "MapEmbeddableOutput", + { + "pluginId": "maps", + "scope": "public", + "docId": "kibMapsPluginApi", + "section": "def-public.MapEmbeddableOutput", + "text": "MapEmbeddableOutput" + }, "> implements ", { "pluginId": "embeddable", @@ -52,7 +58,7 @@ "description": [], "source": { "path": "x-pack/plugins/maps/public/embeddable/map_embeddable.tsx", - "lineNumber": 94 + "lineNumber": 93 } }, { @@ -75,7 +81,7 @@ "description": [], "source": { "path": "x-pack/plugins/maps/public/embeddable/map_embeddable.tsx", - "lineNumber": 111 + "lineNumber": 110 } }, { @@ -95,7 +101,7 @@ "description": [], "source": { "path": "x-pack/plugins/maps/public/embeddable/map_embeddable.tsx", - "lineNumber": 111 + "lineNumber": 110 } }, { @@ -132,7 +138,7 @@ "description": [], "source": { "path": "x-pack/plugins/maps/public/embeddable/map_embeddable.tsx", - "lineNumber": 111 + "lineNumber": 110 } } ], @@ -140,7 +146,7 @@ "returnComment": [], "source": { "path": "x-pack/plugins/maps/public/embeddable/map_embeddable.tsx", - "lineNumber": 111 + "lineNumber": 110 } }, { @@ -178,7 +184,7 @@ "description": [], "source": { "path": "x-pack/plugins/maps/public/embeddable/map_embeddable.tsx", - "lineNumber": 186 + "lineNumber": 185 } } ], @@ -186,7 +192,7 @@ "returnComment": [], "source": { "path": "x-pack/plugins/maps/public/embeddable/map_embeddable.tsx", - "lineNumber": 185 + "lineNumber": 184 } }, { @@ -204,7 +210,7 @@ "returnComment": [], "source": { "path": "x-pack/plugins/maps/public/embeddable/map_embeddable.tsx", - "lineNumber": 191 + "lineNumber": 190 } }, { @@ -222,7 +228,7 @@ "returnComment": [], "source": { "path": "x-pack/plugins/maps/public/embeddable/map_embeddable.tsx", - "lineNumber": 199 + "lineNumber": 198 } }, { @@ -238,7 +244,7 @@ "returnComment": [], "source": { "path": "x-pack/plugins/maps/public/embeddable/map_embeddable.tsx", - "lineNumber": 204 + "lineNumber": 203 } }, { @@ -254,7 +260,7 @@ "returnComment": [], "source": { "path": "x-pack/plugins/maps/public/embeddable/map_embeddable.tsx", - "lineNumber": 208 + "lineNumber": 207 } }, { @@ -272,7 +278,7 @@ "description": [], "source": { "path": "x-pack/plugins/maps/public/embeddable/map_embeddable.tsx", - "lineNumber": 212 + "lineNumber": 211 } } ], @@ -285,7 +291,7 @@ "label": "setRenderTooltipContent", "source": { "path": "x-pack/plugins/maps/public/embeddable/map_embeddable.tsx", - "lineNumber": 212 + "lineNumber": 211 }, "tags": [], "returnComment": [] @@ -305,7 +311,7 @@ "description": [], "source": { "path": "x-pack/plugins/maps/public/embeddable/map_embeddable.tsx", - "lineNumber": 216 + "lineNumber": 215 } } ], @@ -318,7 +324,7 @@ "label": "setEventHandlers", "source": { "path": "x-pack/plugins/maps/public/embeddable/map_embeddable.tsx", - "lineNumber": 216 + "lineNumber": 215 }, "tags": [], "returnComment": [] @@ -343,7 +349,7 @@ "returnComment": [], "source": { "path": "x-pack/plugins/maps/public/embeddable/map_embeddable.tsx", - "lineNumber": 220 + "lineNumber": 219 } }, { @@ -359,7 +365,7 @@ "returnComment": [], "source": { "path": "x-pack/plugins/maps/public/embeddable/map_embeddable.tsx", - "lineNumber": 224 + "lineNumber": 223 } }, { @@ -386,13 +392,13 @@ "description": [], "source": { "path": "x-pack/plugins/maps/public/embeddable/map_embeddable.tsx", - "lineNumber": 256 + "lineNumber": 255 } } ], "source": { "path": "x-pack/plugins/maps/public/embeddable/map_embeddable.tsx", - "lineNumber": 256 + "lineNumber": 255 } } ], @@ -400,7 +406,7 @@ "returnComment": [], "source": { "path": "x-pack/plugins/maps/public/embeddable/map_embeddable.tsx", - "lineNumber": 256 + "lineNumber": 255 } }, { @@ -437,7 +443,7 @@ "description": [], "source": { "path": "x-pack/plugins/maps/public/embeddable/map_embeddable.tsx", - "lineNumber": 278 + "lineNumber": 277 } } ], @@ -445,7 +451,7 @@ "returnComment": [], "source": { "path": "x-pack/plugins/maps/public/embeddable/map_embeddable.tsx", - "lineNumber": 278 + "lineNumber": 277 } }, { @@ -468,7 +474,7 @@ "description": [], "source": { "path": "x-pack/plugins/maps/public/embeddable/map_embeddable.tsx", - "lineNumber": 288 + "lineNumber": 287 } } ], @@ -476,7 +482,7 @@ "returnComment": [], "source": { "path": "x-pack/plugins/maps/public/embeddable/map_embeddable.tsx", - "lineNumber": 288 + "lineNumber": 287 } }, { @@ -501,7 +507,7 @@ "description": [], "source": { "path": "x-pack/plugins/maps/public/embeddable/map_embeddable.tsx", - "lineNumber": 306 + "lineNumber": 305 } } ], @@ -509,7 +515,7 @@ "returnComment": [], "source": { "path": "x-pack/plugins/maps/public/embeddable/map_embeddable.tsx", - "lineNumber": 306 + "lineNumber": 305 } }, { @@ -535,7 +541,7 @@ "description": [], "source": { "path": "x-pack/plugins/maps/public/embeddable/map_embeddable.tsx", - "lineNumber": 332 + "lineNumber": 331 } } ], @@ -543,7 +549,7 @@ "returnComment": [], "source": { "path": "x-pack/plugins/maps/public/embeddable/map_embeddable.tsx", - "lineNumber": 332 + "lineNumber": 331 } }, { @@ -561,7 +567,7 @@ "description": [], "source": { "path": "x-pack/plugins/maps/public/embeddable/map_embeddable.tsx", - "lineNumber": 349 + "lineNumber": 348 } }, { @@ -575,7 +581,7 @@ "description": [], "source": { "path": "x-pack/plugins/maps/public/embeddable/map_embeddable.tsx", - "lineNumber": 349 + "lineNumber": 348 } }, { @@ -595,7 +601,7 @@ "description": [], "source": { "path": "x-pack/plugins/maps/public/embeddable/map_embeddable.tsx", - "lineNumber": 349 + "lineNumber": 348 } } ], @@ -614,7 +620,7 @@ "label": "onSingleValueTrigger", "source": { "path": "x-pack/plugins/maps/public/embeddable/map_embeddable.tsx", - "lineNumber": 349 + "lineNumber": 348 }, "tags": [], "returnComment": [] @@ -641,7 +647,7 @@ "description": [], "source": { "path": "x-pack/plugins/maps/public/embeddable/map_embeddable.tsx", - "lineNumber": 363 + "lineNumber": 362 } }, { @@ -655,7 +661,7 @@ "description": [], "source": { "path": "x-pack/plugins/maps/public/embeddable/map_embeddable.tsx", - "lineNumber": 363 + "lineNumber": 362 } } ], @@ -674,7 +680,7 @@ "label": "addFilters", "source": { "path": "x-pack/plugins/maps/public/embeddable/map_embeddable.tsx", - "lineNumber": 363 + "lineNumber": 362 }, "tags": [], "returnComment": [] @@ -698,7 +704,7 @@ "label": "getFilterActions", "source": { "path": "x-pack/plugins/maps/public/embeddable/map_embeddable.tsx", - "lineNumber": 375 + "lineNumber": 374 }, "tags": [], "returnComment": [] @@ -722,7 +728,7 @@ "label": "getActionContext", "source": { "path": "x-pack/plugins/maps/public/embeddable/map_embeddable.tsx", - "lineNumber": 396 + "lineNumber": 395 }, "tags": [], "returnComment": [] @@ -740,7 +746,7 @@ "returnComment": [], "source": { "path": "x-pack/plugins/maps/public/embeddable/map_embeddable.tsx", - "lineNumber": 407 + "lineNumber": 406 } }, { @@ -756,7 +762,7 @@ "returnComment": [], "source": { "path": "x-pack/plugins/maps/public/embeddable/map_embeddable.tsx", - "lineNumber": 423 + "lineNumber": 422 } }, { @@ -772,19 +778,55 @@ "returnComment": [], "source": { "path": "x-pack/plugins/maps/public/embeddable/map_embeddable.tsx", - "lineNumber": 429 + "lineNumber": 428 } } ], "source": { "path": "x-pack/plugins/maps/public/embeddable/map_embeddable.tsx", - "lineNumber": 91 + "lineNumber": 90 }, "initialIsOpen": false } ], "functions": [], "interfaces": [ + { + "id": "def-public.EMSTermJoinConfig", + "type": "Interface", + "label": "EMSTermJoinConfig", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-public.EMSTermJoinConfig.layerId", + "type": "string", + "label": "layerId", + "description": [], + "source": { + "path": "x-pack/plugins/maps/public/ems_autosuggest/ems_autosuggest.ts", + "lineNumber": 19 + } + }, + { + "tags": [], + "id": "def-public.EMSTermJoinConfig.field", + "type": "string", + "label": "field", + "description": [], + "source": { + "path": "x-pack/plugins/maps/public/ems_autosuggest/ems_autosuggest.ts", + "lineNumber": 20 + } + } + ], + "source": { + "path": "x-pack/plugins/maps/public/ems_autosuggest/ems_autosuggest.ts", + "lineNumber": 18 + }, + "initialIsOpen": false + }, { "id": "def-public.RenderTooltipContentParams", "type": "Interface", @@ -985,6 +1027,62 @@ "lineNumber": 31 }, "initialIsOpen": false + }, + { + "id": "def-public.SampleValuesConfig", + "type": "Interface", + "label": "SampleValuesConfig", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-public.SampleValuesConfig.emsLayerIds", + "type": "Array", + "label": "emsLayerIds", + "description": [], + "source": { + "path": "x-pack/plugins/maps/public/ems_autosuggest/ems_autosuggest.ts", + "lineNumber": 13 + }, + "signature": [ + "string[] | undefined" + ] + }, + { + "tags": [], + "id": "def-public.SampleValuesConfig.sampleValues", + "type": "Array", + "label": "sampleValues", + "description": [], + "source": { + "path": "x-pack/plugins/maps/public/ems_autosuggest/ems_autosuggest.ts", + "lineNumber": 14 + }, + "signature": [ + "React.ReactText[] | undefined" + ] + }, + { + "tags": [], + "id": "def-public.SampleValuesConfig.sampleValuesColumnName", + "type": "string", + "label": "sampleValuesColumnName", + "description": [], + "source": { + "path": "x-pack/plugins/maps/public/ems_autosuggest/ems_autosuggest.ts", + "lineNumber": 15 + }, + "signature": [ + "string | undefined" + ] + } + ], + "source": { + "path": "x-pack/plugins/maps/public/ems_autosuggest/ems_autosuggest.ts", + "lineNumber": 12 + }, + "initialIsOpen": false } ], "enums": [], @@ -1020,6 +1118,21 @@ "MapByReferenceInput" ], "initialIsOpen": false + }, + { + "id": "def-public.MapEmbeddableOutput", + "type": "Type", + "label": "MapEmbeddableOutput", + "tags": [], + "description": [], + "source": { + "path": "x-pack/plugins/maps/public/embeddable/types.ts", + "lineNumber": 43 + }, + "signature": [ + "EmbeddableOutput & { indexPatterns: IIndexPattern[]; }" + ], + "initialIsOpen": false } ], "objects": [], @@ -1124,9 +1237,21 @@ "label": "suggestEMSTermJoinConfig", "signature": [ "(config: ", - "SampleValuesConfig", + { + "pluginId": "maps", + "scope": "public", + "docId": "kibMapsPluginApi", + "section": "def-public.SampleValuesConfig", + "text": "SampleValuesConfig" + }, ") => Promise<", - "EMSTermJoinConfig", + { + "pluginId": "maps", + "scope": "public", + "docId": "kibMapsPluginApi", + "section": "def-public.EMSTermJoinConfig", + "text": "EMSTermJoinConfig" + }, " | null>" ], "description": [], @@ -1137,7 +1262,13 @@ "label": "config", "isRequired": true, "signature": [ - "SampleValuesConfig" + { + "pluginId": "maps", + "scope": "public", + "docId": "kibMapsPluginApi", + "section": "def-public.SampleValuesConfig", + "text": "SampleValuesConfig" + } ], "description": [], "source": { @@ -1193,7 +1324,7 @@ "description": [], "source": { "path": "x-pack/plugins/maps/common/constants.ts", - "lineNumber": 64 + "lineNumber": 66 } } ], @@ -1201,7 +1332,7 @@ "returnComment": [], "source": { "path": "x-pack/plugins/maps/common/constants.ts", - "lineNumber": 64 + "lineNumber": 66 }, "initialIsOpen": false }, @@ -1225,7 +1356,7 @@ "description": [], "source": { "path": "x-pack/plugins/maps/common/constants.ts", - "lineNumber": 61 + "lineNumber": 63 } } ], @@ -1233,7 +1364,7 @@ "returnComment": [], "source": { "path": "x-pack/plugins/maps/common/constants.ts", - "lineNumber": 61 + "lineNumber": 63 }, "initialIsOpen": false }, @@ -1250,7 +1381,7 @@ "returnComment": [], "source": { "path": "x-pack/plugins/maps/common/constants.ts", - "lineNumber": 58 + "lineNumber": 60 }, "initialIsOpen": false } @@ -1428,7 +1559,7 @@ "description": [], "source": { "path": "x-pack/plugins/maps/common/constants.ts", - "lineNumber": 161 + "lineNumber": 163 }, "initialIsOpen": false }, @@ -1440,7 +1571,7 @@ "description": [], "source": { "path": "x-pack/plugins/maps/common/constants.ts", - "lineNumber": 209 + "lineNumber": 211 }, "initialIsOpen": false }, @@ -1452,7 +1583,7 @@ "description": [], "source": { "path": "x-pack/plugins/maps/common/constants.ts", - "lineNumber": 290 + "lineNumber": 292 }, "initialIsOpen": false }, @@ -1464,7 +1595,7 @@ "description": [], "source": { "path": "x-pack/plugins/maps/common/constants.ts", - "lineNumber": 154 + "lineNumber": 156 }, "initialIsOpen": false }, @@ -1476,7 +1607,7 @@ "description": [], "source": { "path": "x-pack/plugins/maps/common/constants.ts", - "lineNumber": 121 + "lineNumber": 123 }, "initialIsOpen": false }, @@ -1488,7 +1619,7 @@ "description": [], "source": { "path": "x-pack/plugins/maps/common/constants.ts", - "lineNumber": 129 + "lineNumber": 131 }, "initialIsOpen": false }, @@ -1500,7 +1631,7 @@ "description": [], "source": { "path": "x-pack/plugins/maps/common/constants.ts", - "lineNumber": 94 + "lineNumber": 96 }, "initialIsOpen": false }, @@ -1512,7 +1643,7 @@ "description": [], "source": { "path": "x-pack/plugins/maps/common/constants.ts", - "lineNumber": 253 + "lineNumber": 255 }, "initialIsOpen": false }, @@ -1524,7 +1655,7 @@ "description": [], "source": { "path": "x-pack/plugins/maps/common/constants.ts", - "lineNumber": 135 + "lineNumber": 137 }, "initialIsOpen": false }, @@ -1536,7 +1667,7 @@ "description": [], "source": { "path": "x-pack/plugins/maps/common/constants.ts", - "lineNumber": 178 + "lineNumber": 180 }, "initialIsOpen": false }, @@ -1548,7 +1679,7 @@ "description": [], "source": { "path": "x-pack/plugins/maps/common/constants.ts", - "lineNumber": 265 + "lineNumber": 267 }, "initialIsOpen": false }, @@ -1560,7 +1691,7 @@ "description": [], "source": { "path": "x-pack/plugins/maps/common/constants.ts", - "lineNumber": 222 + "lineNumber": 224 }, "initialIsOpen": false }, @@ -1572,7 +1703,7 @@ "description": [], "source": { "path": "x-pack/plugins/maps/common/constants.ts", - "lineNumber": 203 + "lineNumber": 205 }, "initialIsOpen": false }, @@ -1584,7 +1715,7 @@ "description": [], "source": { "path": "x-pack/plugins/maps/common/constants.ts", - "lineNumber": 68 + "lineNumber": 70 }, "initialIsOpen": false }, @@ -1596,7 +1727,7 @@ "description": [], "source": { "path": "x-pack/plugins/maps/common/constants.ts", - "lineNumber": 272 + "lineNumber": 274 }, "initialIsOpen": false }, @@ -1608,7 +1739,7 @@ "description": [], "source": { "path": "x-pack/plugins/maps/common/constants.ts", - "lineNumber": 285 + "lineNumber": 287 }, "initialIsOpen": false }, @@ -1620,7 +1751,7 @@ "description": [], "source": { "path": "x-pack/plugins/maps/common/constants.ts", - "lineNumber": 258 + "lineNumber": 260 }, "initialIsOpen": false }, @@ -1632,7 +1763,7 @@ "description": [], "source": { "path": "x-pack/plugins/maps/common/constants.ts", - "lineNumber": 172 + "lineNumber": 174 }, "initialIsOpen": false }, @@ -1644,7 +1775,7 @@ "description": [], "source": { "path": "x-pack/plugins/maps/common/constants.ts", - "lineNumber": 246 + "lineNumber": 248 }, "initialIsOpen": false }, @@ -1656,7 +1787,7 @@ "description": [], "source": { "path": "x-pack/plugins/maps/common/constants.ts", - "lineNumber": 77 + "lineNumber": 79 }, "initialIsOpen": false }, @@ -1668,7 +1799,7 @@ "description": [], "source": { "path": "x-pack/plugins/maps/common/constants.ts", - "lineNumber": 198 + "lineNumber": 200 }, "initialIsOpen": false }, @@ -1680,7 +1811,7 @@ "description": [], "source": { "path": "x-pack/plugins/maps/common/constants.ts", - "lineNumber": 217 + "lineNumber": 219 }, "initialIsOpen": false }, @@ -1692,7 +1823,7 @@ "description": [], "source": { "path": "x-pack/plugins/maps/common/constants.ts", - "lineNumber": 278 + "lineNumber": 280 }, "initialIsOpen": false }, @@ -1704,7 +1835,7 @@ "description": [], "source": { "path": "x-pack/plugins/maps/common/constants.ts", - "lineNumber": 231 + "lineNumber": 233 }, "initialIsOpen": false } @@ -1718,7 +1849,7 @@ "description": [], "source": { "path": "x-pack/plugins/maps/common/constants.ts", - "lineNumber": 160 + "lineNumber": 162 }, "signature": [ "\"_of_\"" @@ -1802,7 +1933,7 @@ "description": [], "source": { "path": "x-pack/plugins/maps/common/constants.ts", - "lineNumber": 214 + "lineNumber": 216 }, "signature": [ "string[]" @@ -1817,7 +1948,7 @@ "description": [], "source": { "path": "x-pack/plugins/maps/common/constants.ts", - "lineNumber": 192 + "lineNumber": 194 }, "initialIsOpen": false }, @@ -1829,7 +1960,7 @@ "description": [], "source": { "path": "x-pack/plugins/maps/common/constants.ts", - "lineNumber": 196 + "lineNumber": 198 }, "signature": [ "\"doc_count\"" @@ -1844,7 +1975,7 @@ "description": [], "source": { "path": "x-pack/plugins/maps/common/constants.ts", - "lineNumber": 110 + "lineNumber": 112 }, "signature": [ "5" @@ -1859,7 +1990,7 @@ "description": [], "source": { "path": "x-pack/plugins/maps/common/constants.ts", - "lineNumber": 229 + "lineNumber": 231 }, "signature": [ "\"marker\"" @@ -1874,7 +2005,7 @@ "description": [], "source": { "path": "x-pack/plugins/maps/common/constants.ts", - "lineNumber": 114 + "lineNumber": 116 }, "signature": [ "65535" @@ -1889,7 +2020,7 @@ "description": [], "source": { "path": "x-pack/plugins/maps/common/constants.ts", - "lineNumber": 113 + "lineNumber": 115 }, "signature": [ "100" @@ -1904,7 +2035,7 @@ "description": [], "source": { "path": "x-pack/plugins/maps/common/constants.ts", - "lineNumber": 112 + "lineNumber": 114 }, "signature": [ "10000" @@ -1919,7 +2050,7 @@ "description": [], "source": { "path": "x-pack/plugins/maps/common/constants.ts", - "lineNumber": 190 + "lineNumber": 192 }, "signature": [ "50" @@ -1934,7 +2065,7 @@ "description": [], "source": { "path": "x-pack/plugins/maps/common/constants.ts", - "lineNumber": 294 + "lineNumber": 296 }, "signature": [ "number[]" @@ -2159,7 +2290,7 @@ "description": [], "source": { "path": "x-pack/plugins/maps/common/constants.ts", - "lineNumber": 305 + "lineNumber": 307 }, "signature": [ "\"administrative_regions_lvl2\"" @@ -2174,7 +2305,7 @@ "description": [], "source": { "path": "x-pack/plugins/maps/common/constants.ts", - "lineNumber": 306 + "lineNumber": 308 }, "signature": [ "\"usa_zip_codes\"" @@ -2189,7 +2320,7 @@ "description": [], "source": { "path": "x-pack/plugins/maps/common/constants.ts", - "lineNumber": 304 + "lineNumber": 306 }, "signature": [ "\"world_countries\"" @@ -2204,7 +2335,7 @@ "description": [], "source": { "path": "x-pack/plugins/maps/common/constants.ts", - "lineNumber": 127 + "lineNumber": 129 }, "signature": [ "string[]" @@ -2219,7 +2350,7 @@ "description": [], "source": { "path": "x-pack/plugins/maps/common/constants.ts", - "lineNumber": 116 + "lineNumber": 118 }, "signature": [ "\"__kbn__feature_id__\"" @@ -2234,7 +2365,7 @@ "description": [], "source": { "path": "x-pack/plugins/maps/common/constants.ts", - "lineNumber": 117 + "lineNumber": 119 }, "signature": [ "\"__kbn_isvisibleduetojoin__\"" @@ -2249,7 +2380,7 @@ "description": [], "source": { "path": "x-pack/plugins/maps/common/constants.ts", - "lineNumber": 298 + "lineNumber": 300 }, "signature": [ "(value: ", @@ -2284,7 +2415,7 @@ "description": [], "source": { "path": "x-pack/plugins/maps/common/constants.ts", - "lineNumber": 101 + "lineNumber": 103 }, "signature": [ "\"formatters\"" @@ -2299,7 +2430,7 @@ "description": [], "source": { "path": "x-pack/plugins/maps/common/constants.ts", - "lineNumber": 187 + "lineNumber": 189 }, "signature": [ "\"gridCentroid\"" @@ -2314,7 +2445,7 @@ "description": [], "source": { "path": "x-pack/plugins/maps/common/constants.ts", - "lineNumber": 186 + "lineNumber": 188 }, "signature": [ "\"gridSplit\"" @@ -2341,7 +2472,7 @@ "description": [], "source": { "path": "x-pack/plugins/maps/common/constants.ts", - "lineNumber": 300 + "lineNumber": 302 }, "signature": [ "\"maps-drawing-data-ingest\"" @@ -2395,7 +2526,7 @@ "description": [], "source": { "path": "x-pack/plugins/maps/common/constants.ts", - "lineNumber": 98 + "lineNumber": 100 }, "signature": [ "\"__kbnjoin__\"" @@ -2455,7 +2586,7 @@ "description": [], "source": { "path": "x-pack/plugins/maps/common/constants.ts", - "lineNumber": 147 + "lineNumber": 149 }, "signature": [ "1" @@ -2470,7 +2601,7 @@ "description": [], "source": { "path": "x-pack/plugins/maps/common/constants.ts", - "lineNumber": 146 + "lineNumber": 148 }, "signature": [ "0" @@ -2527,7 +2658,7 @@ "description": [], "source": { "path": "x-pack/plugins/maps/common/constants.ts", - "lineNumber": 302 + "lineNumber": 304 }, "signature": [ "10485760" @@ -2542,7 +2673,7 @@ "description": [], "source": { "path": "x-pack/plugins/maps/common/constants.ts", - "lineNumber": 108 + "lineNumber": 110 }, "signature": [ "24" @@ -2557,7 +2688,7 @@ "description": [], "source": { "path": "x-pack/plugins/maps/common/constants.ts", - "lineNumber": 119 + "lineNumber": 121 }, "signature": [ "\"_\"" @@ -2572,7 +2703,7 @@ "description": [], "source": { "path": "x-pack/plugins/maps/common/constants.ts", - "lineNumber": 100 + "lineNumber": 102 }, "signature": [ "\"meta\"" @@ -2587,7 +2718,7 @@ "description": [], "source": { "path": "x-pack/plugins/maps/common/constants.ts", - "lineNumber": 107 + "lineNumber": 109 }, "signature": [ "0" @@ -2639,6 +2770,21 @@ ], "initialIsOpen": false }, + { + "tags": [], + "id": "def-common.MVT_TOKEN_PARAM_NAME", + "type": "string", + "label": "MVT_TOKEN_PARAM_NAME", + "description": [], + "source": { + "path": "x-pack/plugins/maps/common/constants.ts", + "lineNumber": 57 + }, + "signature": [ + "\"token\"" + ], + "initialIsOpen": false + }, { "tags": [], "id": "def-common.ORDINAL_DATA_TYPES", @@ -2647,7 +2793,7 @@ "description": [], "source": { "path": "x-pack/plugins/maps/common/constants.ts", - "lineNumber": 215 + "lineNumber": 217 }, "signature": [ "string[]" @@ -2662,7 +2808,7 @@ "description": [], "source": { "path": "x-pack/plugins/maps/common/constants.ts", - "lineNumber": 145 + "lineNumber": 147 }, "signature": [ "0" @@ -2677,10 +2823,10 @@ "description": [], "source": { "path": "x-pack/plugins/maps/common/constants.ts", - "lineNumber": 296 + "lineNumber": 298 }, "signature": [ - "undefined | null | string | number | false | true" + "undefined | null | string | number | false | true | string[]" ], "initialIsOpen": false }, @@ -2692,7 +2838,7 @@ "description": [], "source": { "path": "x-pack/plugins/maps/common/constants.ts", - "lineNumber": 105 + "lineNumber": 107 }, "initialIsOpen": false }, @@ -2704,7 +2850,7 @@ "description": [], "source": { "path": "x-pack/plugins/maps/common/constants.ts", - "lineNumber": 102 + "lineNumber": 104 }, "signature": [ "\"source\"" @@ -2719,7 +2865,7 @@ "description": [], "source": { "path": "x-pack/plugins/maps/common/constants.ts", - "lineNumber": 104 + "lineNumber": 106 }, "initialIsOpen": false }, @@ -2731,7 +2877,7 @@ "description": [], "source": { "path": "x-pack/plugins/maps/common/constants.ts", - "lineNumber": 103 + "lineNumber": 105 }, "initialIsOpen": false }, @@ -2743,7 +2889,7 @@ "description": [], "source": { "path": "x-pack/plugins/maps/common/constants.ts", - "lineNumber": 263 + "lineNumber": 265 }, "signature": [ "\"SPATIAL_FILTERS_LAYER_ID\"" @@ -2758,7 +2904,7 @@ "description": [], "source": { "path": "x-pack/plugins/maps/common/constants.ts", - "lineNumber": 185 + "lineNumber": 187 }, "signature": [ "7" @@ -2773,7 +2919,7 @@ "description": [], "source": { "path": "x-pack/plugins/maps/common/constants.ts", - "lineNumber": 189 + "lineNumber": 191 }, "signature": [ "\"__percentage\"" @@ -2788,7 +2934,7 @@ "description": [], "source": { "path": "x-pack/plugins/maps/common/constants.ts", - "lineNumber": 111 + "lineNumber": 113 }, "signature": [ "2" @@ -2810,7 +2956,7 @@ "description": [], "source": { "path": "x-pack/plugins/maps/common/constants.ts", - "lineNumber": 150 + "lineNumber": 152 }, "signature": [ "\"FeatureCollection\"" @@ -2824,7 +2970,7 @@ "description": [], "source": { "path": "x-pack/plugins/maps/common/constants.ts", - "lineNumber": 151 + "lineNumber": 153 }, "signature": [ "never[]" @@ -2835,7 +2981,7 @@ "label": "EMPTY_FEATURE_COLLECTION", "source": { "path": "x-pack/plugins/maps/common/constants.ts", - "lineNumber": 149 + "lineNumber": 151 }, "initialIsOpen": false } diff --git a/api_docs/maps_ems.json b/api_docs/maps_ems.json index 2619d711f9b74..3f1ef77cf6cb7 100644 --- a/api_docs/maps_ems.json +++ b/api_docs/maps_ems.json @@ -597,6 +597,21 @@ ], "enums": [], "misc": [ + { + "tags": [], + "id": "def-public.DEFAULT_EMS_DARKMAP_ID", + "type": "string", + "label": "DEFAULT_EMS_DARKMAP_ID", + "description": [], + "source": { + "path": "src/plugins/maps_ems/common/ems_defaults.ts", + "lineNumber": 18 + }, + "signature": [ + "\"dark_map\"" + ], + "initialIsOpen": false + }, { "tags": [], "id": "def-public.DEFAULT_EMS_FILE_API_URL", @@ -638,7 +653,37 @@ "lineNumber": 12 }, "signature": [ - "\"https://maps.elastic.co/v7.12\"" + "\"https://maps.elastic.co/v7.13\"" + ], + "initialIsOpen": false + }, + { + "tags": [], + "id": "def-public.DEFAULT_EMS_ROADMAP_DESATURATED_ID", + "type": "string", + "label": "DEFAULT_EMS_ROADMAP_DESATURATED_ID", + "description": [], + "source": { + "path": "src/plugins/maps_ems/common/ems_defaults.ts", + "lineNumber": 17 + }, + "signature": [ + "\"road_map_desaturated\"" + ], + "initialIsOpen": false + }, + { + "tags": [], + "id": "def-public.DEFAULT_EMS_ROADMAP_ID", + "type": "string", + "label": "DEFAULT_EMS_ROADMAP_ID", + "description": [], + "source": { + "path": "src/plugins/maps_ems/common/ems_defaults.ts", + "lineNumber": 16 + }, + "signature": [ + "\"road_map\"" ], "initialIsOpen": false }, @@ -665,7 +710,7 @@ "description": [], "source": { "path": "src/plugins/maps_ems/config.ts", - "lineNumber": 54 + "lineNumber": 57 }, "signature": [ "{ readonly name: string; readonly format: Readonly<{} & { type: string; }>; readonly fields: Readonly<{} & { description: string; name: string; }>[]; readonly meta: Readonly<{} & { feature_collection_path: string; }>; readonly url: string; readonly attribution: string; }" @@ -680,7 +725,7 @@ "description": [], "source": { "path": "src/plugins/maps_ems/config.ts", - "lineNumber": 86 + "lineNumber": 89 }, "signature": [ "{ readonly includeElasticMapsService: boolean; readonly proxyElasticMapsServiceInMaps: boolean; readonly regionmap: Readonly<{} & { includeElasticMapsService: boolean; layers: Readonly<{} & { name: string; format: Readonly<{} & { type: string; }>; fields: Readonly<{} & { description: string; name: string; }>[]; meta: Readonly<{} & { feature_collection_path: string; }>; url: string; attribution: string; }>[]; }>; readonly tilemap: Readonly<{ url?: string | undefined; } & { options: Readonly<{ default?: boolean | undefined; tileSize?: number | undefined; subdomains?: string[] | undefined; errorTileUrl?: string | undefined; tms?: boolean | undefined; reuseTiles?: boolean | undefined; bounds?: number[] | undefined; } & { attribution: string; minZoom: number; maxZoom: number; }>; }>; readonly manifestServiceUrl: string; readonly emsUrl: string; readonly emsFileApiUrl: string; readonly emsTileApiUrl: string; readonly emsLandingPageUrl: string; readonly emsFontLibraryUrl: string; readonly emsTileLayerId: Readonly<{} & { bright: string; desaturated: string; dark: string; }>; }" @@ -1014,6 +1059,21 @@ "interfaces": [], "enums": [], "misc": [ + { + "tags": [], + "id": "def-common.DEFAULT_EMS_DARKMAP_ID", + "type": "string", + "label": "DEFAULT_EMS_DARKMAP_ID", + "description": [], + "source": { + "path": "src/plugins/maps_ems/common/ems_defaults.ts", + "lineNumber": 18 + }, + "signature": [ + "\"dark_map\"" + ], + "initialIsOpen": false + }, { "tags": [], "id": "def-common.DEFAULT_EMS_FILE_API_URL", @@ -1055,7 +1115,37 @@ "lineNumber": 12 }, "signature": [ - "\"https://maps.elastic.co/v7.12\"" + "\"https://maps.elastic.co/v7.13\"" + ], + "initialIsOpen": false + }, + { + "tags": [], + "id": "def-common.DEFAULT_EMS_ROADMAP_DESATURATED_ID", + "type": "string", + "label": "DEFAULT_EMS_ROADMAP_DESATURATED_ID", + "description": [], + "source": { + "path": "src/plugins/maps_ems/common/ems_defaults.ts", + "lineNumber": 17 + }, + "signature": [ + "\"road_map_desaturated\"" + ], + "initialIsOpen": false + }, + { + "tags": [], + "id": "def-common.DEFAULT_EMS_ROADMAP_ID", + "type": "string", + "label": "DEFAULT_EMS_ROADMAP_ID", + "description": [], + "source": { + "path": "src/plugins/maps_ems/common/ems_defaults.ts", + "lineNumber": 16 + }, + "signature": [ + "\"road_map\"" ], "initialIsOpen": false }, diff --git a/api_docs/ml.json b/api_docs/ml.json index fc9d09c22c4a7..36a3cf4179f31 100644 --- a/api_docs/ml.json +++ b/api_docs/ml.json @@ -161,12 +161,45 @@ "label": "getMlSharedImports", "source": { "path": "x-pack/plugins/ml/public/index.ts", - "lineNumber": 60 + "lineNumber": 61 }, "tags": [], "returnComment": [], "initialIsOpen": false }, + { + "id": "def-public.getSeverity", + "type": "Function", + "label": "getSeverity", + "signature": [ + "(normalizedScore: number) => ", + "SeverityType" + ], + "description": [], + "children": [ + { + "id": "def-public.getSeverity.$1", + "type": "number", + "label": "normalizedScore", + "isRequired": true, + "signature": [ + "number" + ], + "description": [], + "source": { + "path": "x-pack/plugins/ml/common/util/anomaly_utils.ts", + "lineNumber": 130 + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "x-pack/plugins/ml/common/util/anomaly_utils.ts", + "lineNumber": 130 + }, + "initialIsOpen": false + }, { "id": "def-public.getSeverityColor", "type": "Function", @@ -734,7 +767,7 @@ "description": [], "source": { "path": "x-pack/plugins/ml/common/types/capabilities.ts", - "lineNumber": 151 + "lineNumber": 154 }, "signature": [ "MlCapabilities" @@ -748,7 +781,7 @@ "description": [], "source": { "path": "x-pack/plugins/ml/common/types/capabilities.ts", - "lineNumber": 152 + "lineNumber": 155 } }, { @@ -759,7 +792,7 @@ "description": [], "source": { "path": "x-pack/plugins/ml/common/types/capabilities.ts", - "lineNumber": 153 + "lineNumber": 156 } }, { @@ -770,13 +803,13 @@ "description": [], "source": { "path": "x-pack/plugins/ml/common/types/capabilities.ts", - "lineNumber": 154 + "lineNumber": 157 } } ], "source": { "path": "x-pack/plugins/ml/common/types/capabilities.ts", - "lineNumber": 150 + "lineNumber": 153 }, "initialIsOpen": false }, @@ -795,7 +828,7 @@ "description": [], "source": { "path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/summary_job.ts", - "lineNumber": 15 + "lineNumber": 16 } }, { @@ -806,7 +839,7 @@ "description": [], "source": { "path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/summary_job.ts", - "lineNumber": 16 + "lineNumber": 17 } }, { @@ -817,7 +850,7 @@ "description": [], "source": { "path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/summary_job.ts", - "lineNumber": 17 + "lineNumber": 18 }, "signature": [ "string[]" @@ -831,7 +864,7 @@ "description": [], "source": { "path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/summary_job.ts", - "lineNumber": 18 + "lineNumber": 19 }, "signature": [ "number | undefined" @@ -845,7 +878,7 @@ "description": [], "source": { "path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/summary_job.ts", - "lineNumber": 19 + "lineNumber": 20 }, "signature": [ "string | undefined" @@ -859,7 +892,7 @@ "description": [], "source": { "path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/summary_job.ts", - "lineNumber": 20 + "lineNumber": 21 } }, { @@ -870,7 +903,7 @@ "description": [], "source": { "path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/summary_job.ts", - "lineNumber": 21 + "lineNumber": 22 }, "signature": [ "string[]" @@ -884,7 +917,7 @@ "description": [], "source": { "path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/summary_job.ts", - "lineNumber": 22 + "lineNumber": 23 } }, { @@ -895,7 +928,7 @@ "description": [], "source": { "path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/summary_job.ts", - "lineNumber": 23 + "lineNumber": 24 } }, { @@ -906,7 +939,7 @@ "description": [], "source": { "path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/summary_job.ts", - "lineNumber": 24 + "lineNumber": 25 } }, { @@ -917,7 +950,7 @@ "description": [], "source": { "path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/summary_job.ts", - "lineNumber": 25 + "lineNumber": 26 }, "signature": [ "number | undefined" @@ -931,7 +964,7 @@ "description": [], "source": { "path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/summary_job.ts", - "lineNumber": 26 + "lineNumber": 27 }, "signature": [ "number | undefined" @@ -945,7 +978,7 @@ "description": [], "source": { "path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/summary_job.ts", - "lineNumber": 27 + "lineNumber": 28 }, "signature": [ "number | undefined" @@ -959,7 +992,7 @@ "description": [], "source": { "path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/summary_job.ts", - "lineNumber": 28 + "lineNumber": 29 }, "signature": [ "CombinedJob", @@ -974,7 +1007,7 @@ "description": [], "source": { "path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/summary_job.ts", - "lineNumber": 29 + "lineNumber": 30 }, "signature": [ "string | undefined" @@ -988,7 +1021,7 @@ "description": [], "source": { "path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/summary_job.ts", - "lineNumber": 30 + "lineNumber": 31 }, "signature": [ "Partial<", @@ -1004,7 +1037,7 @@ "description": [], "source": { "path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/summary_job.ts", - "lineNumber": 31 + "lineNumber": 32 } }, { @@ -1015,7 +1048,7 @@ "description": [], "source": { "path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/summary_job.ts", - "lineNumber": 32 + "lineNumber": 33 }, "signature": [ "string | undefined" @@ -1029,7 +1062,7 @@ "description": [], "source": { "path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/summary_job.ts", - "lineNumber": 33 + "lineNumber": 34 }, "signature": [ "boolean | undefined" @@ -1043,7 +1076,7 @@ "description": [], "source": { "path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/summary_job.ts", - "lineNumber": 34 + "lineNumber": 35 }, "signature": [ "number | undefined" @@ -1057,7 +1090,7 @@ "description": [], "source": { "path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/summary_job.ts", - "lineNumber": 35 + "lineNumber": 36 }, "signature": [ "number | undefined" @@ -1071,13 +1104,37 @@ "description": [], "source": { "path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/summary_job.ts", - "lineNumber": 36 + "lineNumber": 37 } + }, + { + "tags": [], + "id": "def-public.MlSummaryJob.alertingRules", + "type": "Array", + "label": "alertingRules", + "description": [], + "source": { + "path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/summary_job.ts", + "lineNumber": 38 + }, + "signature": [ + "Pick<", + { + "pluginId": "alerting", + "scope": "common", + "docId": "kibAlertingPluginApi", + "section": "def-common.Alert", + "text": "Alert" + }, + "<", + "MlAnomalyDetectionAlertParams", + ">, \"enabled\" | \"id\" | \"name\" | \"params\" | \"actions\" | \"tags\" | \"muteAll\" | \"alertTypeId\" | \"consumer\" | \"schedule\" | \"scheduledTaskId\" | \"createdBy\" | \"updatedBy\" | \"createdAt\" | \"updatedAt\" | \"apiKeyOwner\" | \"throttle\" | \"notifyWhen\" | \"mutedInstanceIds\" | \"executionStatus\">[] | undefined" + ] } ], "source": { "path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/summary_job.ts", - "lineNumber": 14 + "lineNumber": 15 }, "initialIsOpen": false }, @@ -1211,7 +1268,7 @@ "description": [], "source": { "path": "x-pack/plugins/ml/public/index.ts", - "lineNumber": 65 + "lineNumber": 66 }, "signature": [ "typeof ", @@ -1279,7 +1336,7 @@ "description": [], "source": { "path": "x-pack/plugins/ml/public/plugin.ts", - "lineNumber": 209 + "lineNumber": 212 }, "signature": [ "{ urlGenerator: UrlGeneratorContract<\"ML_APP_URL_GENERATOR\"> | undefined; }" @@ -1295,7 +1352,7 @@ "description": [], "source": { "path": "x-pack/plugins/ml/public/plugin.ts", - "lineNumber": 210 + "lineNumber": 213 }, "signature": [ "{ urlGenerator: UrlGeneratorContract<\"ML_APP_URL_GENERATOR\"> | undefined; }" @@ -1616,7 +1673,7 @@ "description": [], "source": { "path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/combined_job.ts", - "lineNumber": 28 + "lineNumber": 29 } } ], @@ -1624,7 +1681,7 @@ "returnComment": [], "source": { "path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/combined_job.ts", - "lineNumber": 28 + "lineNumber": 29 }, "initialIsOpen": false } @@ -2341,7 +2398,7 @@ "description": [], "source": { "path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/summary_job.ts", - "lineNumber": 40 + "lineNumber": 42 } }, { @@ -2352,7 +2409,7 @@ "description": [], "source": { "path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/summary_job.ts", - "lineNumber": 41 + "lineNumber": 43 } }, { @@ -2363,7 +2420,7 @@ "description": [], "source": { "path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/summary_job.ts", - "lineNumber": 42 + "lineNumber": 44 } }, { @@ -2374,7 +2431,7 @@ "description": [], "source": { "path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/summary_job.ts", - "lineNumber": 43 + "lineNumber": 45 } }, { @@ -2385,7 +2442,7 @@ "description": [], "source": { "path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/summary_job.ts", - "lineNumber": 44 + "lineNumber": 46 } }, { @@ -2396,13 +2453,13 @@ "description": [], "source": { "path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/summary_job.ts", - "lineNumber": 45 + "lineNumber": 47 } } ], "source": { "path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/summary_job.ts", - "lineNumber": 39 + "lineNumber": 41 }, "initialIsOpen": false }, @@ -2426,7 +2483,7 @@ "description": [], "source": { "path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/combined_job.ts", - "lineNumber": 19 + "lineNumber": 20 }, "signature": [ "string[] | undefined" @@ -2440,7 +2497,7 @@ "description": [], "source": { "path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/combined_job.ts", - "lineNumber": 20 + "lineNumber": 21 }, "signature": [ "Datafeed" @@ -2449,7 +2506,7 @@ ], "source": { "path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/combined_job.ts", - "lineNumber": 18 + "lineNumber": 19 }, "initialIsOpen": false }, @@ -2473,7 +2530,7 @@ "description": [], "source": { "path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/combined_job.ts", - "lineNumber": 24 + "lineNumber": 25 }, "signature": [ "string[] | undefined" @@ -2487,7 +2544,7 @@ "description": [], "source": { "path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/combined_job.ts", - "lineNumber": 25 + "lineNumber": 26 }, "signature": [ "DatafeedWithStats" @@ -2496,775 +2553,201 @@ ], "source": { "path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/combined_job.ts", - "lineNumber": 23 + "lineNumber": 24 }, "initialIsOpen": false }, { - "id": "def-server.CustomSettings", + "id": "def-server.Influencer", "type": "Interface", - "label": "CustomSettings", + "label": "Influencer", "description": [], "tags": [], "children": [ { "tags": [], - "id": "def-server.CustomSettings.custom_urls", + "id": "def-server.Influencer.influencer_field_name", + "type": "string", + "label": "influencer_field_name", + "description": [], + "source": { + "path": "x-pack/plugins/ml/common/types/anomalies.ts", + "lineNumber": 11 + } + }, + { + "tags": [], + "id": "def-server.Influencer.influencer_field_values", "type": "Array", - "label": "custom_urls", + "label": "influencer_field_values", "description": [], "source": { - "path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/job.ts", - "lineNumber": 16 + "path": "x-pack/plugins/ml/common/types/anomalies.ts", + "lineNumber": 12 }, "signature": [ - "UrlConfig", - "[] | undefined" + "string[]" ] + } + ], + "source": { + "path": "x-pack/plugins/ml/common/types/anomalies.ts", + "lineNumber": 10 + }, + "initialIsOpen": false + }, + { + "id": "def-server.MlJobWithTimeRange", + "type": "Interface", + "label": "MlJobWithTimeRange", + "signature": [ + "MlJobWithTimeRange", + " extends ", + "CombinedJobWithStats" + ], + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-server.MlJobWithTimeRange.id", + "type": "string", + "label": "id", + "description": [], + "source": { + "path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/summary_job.ts", + "lineNumber": 53 + } }, { "tags": [], - "id": "def-server.CustomSettings.created_by", + "id": "def-server.MlJobWithTimeRange.isRunning", "type": "CompoundType", - "label": "created_by", + "label": "isRunning", "description": [], "source": { - "path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/job.ts", - "lineNumber": 17 + "path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/summary_job.ts", + "lineNumber": 54 }, "signature": [ - "CREATED_BY_LABEL", - " | undefined" + "boolean | undefined" + ] + }, + { + "tags": [], + "id": "def-server.MlJobWithTimeRange.isNotSingleMetricViewerJobMessage", + "type": "string", + "label": "isNotSingleMetricViewerJobMessage", + "description": [], + "source": { + "path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/summary_job.ts", + "lineNumber": 55 + }, + "signature": [ + "string | undefined" ] }, { "tags": [], - "id": "def-server.CustomSettings.job_tags", + "id": "def-server.MlJobWithTimeRange.timeRange", "type": "Object", - "label": "job_tags", + "label": "timeRange", "description": [], "source": { - "path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/job.ts", - "lineNumber": 18 + "path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/summary_job.ts", + "lineNumber": 56 }, "signature": [ - "{ [tag: string]: string; } | undefined" + "{ from: number; to: number; fromPx: number; toPx: number; fromMoment: moment.Moment; toMoment: moment.Moment; widthPx: number; label: string; }" ] } ], "source": { - "path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/job.ts", - "lineNumber": 15 + "path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/summary_job.ts", + "lineNumber": 52 }, "initialIsOpen": false }, { - "id": "def-server.DataCounts", + "id": "def-server.MlSummaryJob", "type": "Interface", - "label": "DataCounts", + "label": "MlSummaryJob", "description": [], "tags": [], "children": [ { "tags": [], - "id": "def-server.DataCounts.job_id", + "id": "def-server.MlSummaryJob.id", "type": "string", - "label": "job_id", + "label": "id", "description": [], "source": { - "path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/job_stats.ts", - "lineNumber": 23 + "path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/summary_job.ts", + "lineNumber": 16 } }, { "tags": [], - "id": "def-server.DataCounts.processed_record_count", - "type": "number", - "label": "processed_record_count", + "id": "def-server.MlSummaryJob.description", + "type": "string", + "label": "description", "description": [], "source": { - "path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/job_stats.ts", - "lineNumber": 24 + "path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/summary_job.ts", + "lineNumber": 17 } }, { "tags": [], - "id": "def-server.DataCounts.processed_field_count", - "type": "number", - "label": "processed_field_count", + "id": "def-server.MlSummaryJob.groups", + "type": "Array", + "label": "groups", "description": [], "source": { - "path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/job_stats.ts", - "lineNumber": 25 - } + "path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/summary_job.ts", + "lineNumber": 18 + }, + "signature": [ + "string[]" + ] }, { "tags": [], - "id": "def-server.DataCounts.input_bytes", + "id": "def-server.MlSummaryJob.processed_record_count", "type": "number", - "label": "input_bytes", + "label": "processed_record_count", "description": [], "source": { - "path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/job_stats.ts", - "lineNumber": 26 - } + "path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/summary_job.ts", + "lineNumber": 19 + }, + "signature": [ + "number | undefined" + ] }, { "tags": [], - "id": "def-server.DataCounts.input_field_count", - "type": "number", - "label": "input_field_count", + "id": "def-server.MlSummaryJob.memory_status", + "type": "string", + "label": "memory_status", "description": [], "source": { - "path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/job_stats.ts", - "lineNumber": 27 - } + "path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/summary_job.ts", + "lineNumber": 20 + }, + "signature": [ + "string | undefined" + ] }, { "tags": [], - "id": "def-server.DataCounts.invalid_date_count", - "type": "number", - "label": "invalid_date_count", - "description": [], - "source": { - "path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/job_stats.ts", - "lineNumber": 28 - } - }, - { - "tags": [], - "id": "def-server.DataCounts.missing_field_count", - "type": "number", - "label": "missing_field_count", - "description": [], - "source": { - "path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/job_stats.ts", - "lineNumber": 29 - } - }, - { - "tags": [], - "id": "def-server.DataCounts.out_of_order_timestamp_count", - "type": "number", - "label": "out_of_order_timestamp_count", - "description": [], - "source": { - "path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/job_stats.ts", - "lineNumber": 30 - } - }, - { - "tags": [], - "id": "def-server.DataCounts.empty_bucket_count", - "type": "number", - "label": "empty_bucket_count", - "description": [], - "source": { - "path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/job_stats.ts", - "lineNumber": 31 - } - }, - { - "tags": [], - "id": "def-server.DataCounts.sparse_bucket_count", - "type": "number", - "label": "sparse_bucket_count", - "description": [], - "source": { - "path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/job_stats.ts", - "lineNumber": 32 - } - }, - { - "tags": [], - "id": "def-server.DataCounts.bucket_count", - "type": "number", - "label": "bucket_count", - "description": [], - "source": { - "path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/job_stats.ts", - "lineNumber": 33 - } - }, - { - "tags": [], - "id": "def-server.DataCounts.earliest_record_timestamp", - "type": "number", - "label": "earliest_record_timestamp", - "description": [], - "source": { - "path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/job_stats.ts", - "lineNumber": 34 - } - }, - { - "tags": [], - "id": "def-server.DataCounts.latest_record_timestamp", - "type": "number", - "label": "latest_record_timestamp", - "description": [], - "source": { - "path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/job_stats.ts", - "lineNumber": 35 - } - }, - { - "tags": [], - "id": "def-server.DataCounts.last_data_time", - "type": "number", - "label": "last_data_time", - "description": [], - "source": { - "path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/job_stats.ts", - "lineNumber": 36 - } - }, - { - "tags": [], - "id": "def-server.DataCounts.input_record_count", - "type": "number", - "label": "input_record_count", - "description": [], - "source": { - "path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/job_stats.ts", - "lineNumber": 37 - } - }, - { - "tags": [], - "id": "def-server.DataCounts.latest_empty_bucket_timestamp", - "type": "number", - "label": "latest_empty_bucket_timestamp", - "description": [], - "source": { - "path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/job_stats.ts", - "lineNumber": 38 - } - }, - { - "tags": [], - "id": "def-server.DataCounts.latest_sparse_bucket_timestamp", - "type": "number", - "label": "latest_sparse_bucket_timestamp", - "description": [], - "source": { - "path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/job_stats.ts", - "lineNumber": 39 - } - }, - { - "tags": [], - "id": "def-server.DataCounts.latest_bucket_timestamp", - "type": "number", - "label": "latest_bucket_timestamp", - "description": [], - "source": { - "path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/job_stats.ts", - "lineNumber": 40 - }, - "signature": [ - "number | undefined" - ] - } - ], - "source": { - "path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/job_stats.ts", - "lineNumber": 22 - }, - "initialIsOpen": false - }, - { - "id": "def-server.DatafeedStats", - "type": "Interface", - "label": "DatafeedStats", - "description": [], - "tags": [], - "children": [ - { - "tags": [], - "id": "def-server.DatafeedStats.datafeed_id", - "type": "string", - "label": "datafeed_id", - "description": [], - "source": { - "path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/datafeed_stats.ts", - "lineNumber": 12 - } - }, - { - "tags": [], - "id": "def-server.DatafeedStats.state", - "type": "Enum", - "label": "state", - "description": [], - "source": { - "path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/datafeed_stats.ts", - "lineNumber": 13 - }, - "signature": [ - "DATAFEED_STATE" - ] - }, - { - "tags": [], - "id": "def-server.DatafeedStats.node", - "type": "Object", - "label": "node", - "description": [], - "source": { - "path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/datafeed_stats.ts", - "lineNumber": 14 - }, - "signature": [ - "Node" - ] - }, - { - "tags": [], - "id": "def-server.DatafeedStats.assignment_explanation", - "type": "string", - "label": "assignment_explanation", - "description": [], - "source": { - "path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/datafeed_stats.ts", - "lineNumber": 15 - } - }, - { - "tags": [], - "id": "def-server.DatafeedStats.timing_stats", - "type": "Object", - "label": "timing_stats", - "description": [], - "source": { - "path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/datafeed_stats.ts", - "lineNumber": 16 - }, - "signature": [ - "TimingStats" - ] - } - ], - "source": { - "path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/datafeed_stats.ts", - "lineNumber": 11 - }, - "initialIsOpen": false - }, - { - "id": "def-server.ForecastsStats", - "type": "Interface", - "label": "ForecastsStats", - "description": [], - "tags": [], - "children": [ - { - "tags": [], - "id": "def-server.ForecastsStats.total", - "type": "number", - "label": "total", - "description": [], - "source": { - "path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/job_stats.ts", - "lineNumber": 66 - } - }, - { - "tags": [], - "id": "def-server.ForecastsStats.forecasted_jobs", - "type": "number", - "label": "forecasted_jobs", - "description": [], - "source": { - "path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/job_stats.ts", - "lineNumber": 67 - } - }, - { - "tags": [], - "id": "def-server.ForecastsStats.memory_bytes", - "type": "Any", - "label": "memory_bytes", - "description": [], - "source": { - "path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/job_stats.ts", - "lineNumber": 68 - }, - "signature": [ - "any" - ] - }, - { - "tags": [], - "id": "def-server.ForecastsStats.records", - "type": "Any", - "label": "records", - "description": [], - "source": { - "path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/job_stats.ts", - "lineNumber": 69 - }, - "signature": [ - "any" - ] - }, - { - "tags": [], - "id": "def-server.ForecastsStats.processing_time_ms", - "type": "Any", - "label": "processing_time_ms", - "description": [], - "source": { - "path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/job_stats.ts", - "lineNumber": 70 - }, - "signature": [ - "any" - ] - }, - { - "tags": [], - "id": "def-server.ForecastsStats.status", - "type": "Any", - "label": "status", - "description": [], - "source": { - "path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/job_stats.ts", - "lineNumber": 71 - }, - "signature": [ - "any" - ] - } - ], - "source": { - "path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/job_stats.ts", - "lineNumber": 65 - }, - "initialIsOpen": false - }, - { - "id": "def-server.Influencer", - "type": "Interface", - "label": "Influencer", - "description": [], - "tags": [], - "children": [ - { - "tags": [], - "id": "def-server.Influencer.influencer_field_name", - "type": "string", - "label": "influencer_field_name", - "description": [], - "source": { - "path": "x-pack/plugins/ml/common/types/anomalies.ts", - "lineNumber": 11 - } - }, - { - "tags": [], - "id": "def-server.Influencer.influencer_field_values", - "type": "Array", - "label": "influencer_field_values", - "description": [], - "source": { - "path": "x-pack/plugins/ml/common/types/anomalies.ts", - "lineNumber": 12 - }, - "signature": [ - "string[]" - ] - } - ], - "source": { - "path": "x-pack/plugins/ml/common/types/anomalies.ts", - "lineNumber": 10 - }, - "initialIsOpen": false - }, - { - "id": "def-server.JobStats", - "type": "Interface", - "label": "JobStats", - "description": [], - "tags": [], - "children": [ - { - "tags": [], - "id": "def-server.JobStats.job_id", - "type": "string", - "label": "job_id", - "description": [], - "source": { - "path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/job_stats.ts", - "lineNumber": 11 - } - }, - { - "tags": [], - "id": "def-server.JobStats.data_counts", - "type": "Object", - "label": "data_counts", - "description": [], - "source": { - "path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/job_stats.ts", - "lineNumber": 12 - }, - "signature": [ - "DataCounts" - ] - }, - { - "tags": [], - "id": "def-server.JobStats.model_size_stats", - "type": "Object", - "label": "model_size_stats", - "description": [], - "source": { - "path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/job_stats.ts", - "lineNumber": 13 - }, - "signature": [ - "ModelSizeStats" - ] - }, - { - "tags": [], - "id": "def-server.JobStats.forecasts_stats", - "type": "Object", - "label": "forecasts_stats", - "description": [], - "source": { - "path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/job_stats.ts", - "lineNumber": 14 - }, - "signature": [ - "ForecastsStats" - ] - }, - { - "tags": [], - "id": "def-server.JobStats.state", - "type": "Enum", - "label": "state", - "description": [], - "source": { - "path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/job_stats.ts", - "lineNumber": 15 - }, - "signature": [ - "JOB_STATE" - ] - }, - { - "tags": [], - "id": "def-server.JobStats.node", - "type": "Object", - "label": "node", - "description": [], - "source": { - "path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/job_stats.ts", - "lineNumber": 16 - }, - "signature": [ - "Node" - ] - }, - { - "tags": [], - "id": "def-server.JobStats.assignment_explanation", - "type": "string", - "label": "assignment_explanation", - "description": [], - "source": { - "path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/job_stats.ts", - "lineNumber": 17 - } - }, - { - "tags": [], - "id": "def-server.JobStats.open_time", - "type": "string", - "label": "open_time", - "description": [], - "source": { - "path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/job_stats.ts", - "lineNumber": 18 - } - }, - { - "tags": [], - "id": "def-server.JobStats.timing_stats", - "type": "Object", - "label": "timing_stats", - "description": [], - "source": { - "path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/job_stats.ts", - "lineNumber": 19 - }, - "signature": [ - "TimingStats" - ] - } - ], - "source": { - "path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/job_stats.ts", - "lineNumber": 10 - }, - "initialIsOpen": false - }, - { - "id": "def-server.MlJobWithTimeRange", - "type": "Interface", - "label": "MlJobWithTimeRange", - "signature": [ - "MlJobWithTimeRange", - " extends ", - "CombinedJobWithStats" - ], - "description": [], - "tags": [], - "children": [ - { - "tags": [], - "id": "def-server.MlJobWithTimeRange.id", - "type": "string", - "label": "id", - "description": [], - "source": { - "path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/summary_job.ts", - "lineNumber": 51 - } - }, - { - "tags": [], - "id": "def-server.MlJobWithTimeRange.isRunning", - "type": "CompoundType", - "label": "isRunning", - "description": [], - "source": { - "path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/summary_job.ts", - "lineNumber": 52 - }, - "signature": [ - "boolean | undefined" - ] - }, - { - "tags": [], - "id": "def-server.MlJobWithTimeRange.isNotSingleMetricViewerJobMessage", - "type": "string", - "label": "isNotSingleMetricViewerJobMessage", - "description": [], - "source": { - "path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/summary_job.ts", - "lineNumber": 53 - }, - "signature": [ - "string | undefined" - ] - }, - { - "tags": [], - "id": "def-server.MlJobWithTimeRange.timeRange", - "type": "Object", - "label": "timeRange", - "description": [], - "source": { - "path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/summary_job.ts", - "lineNumber": 54 - }, - "signature": [ - "{ from: number; to: number; fromPx: number; toPx: number; fromMoment: moment.Moment; toMoment: moment.Moment; widthPx: number; label: string; }" - ] - } - ], - "source": { - "path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/summary_job.ts", - "lineNumber": 50 - }, - "initialIsOpen": false - }, - { - "id": "def-server.MlSummaryJob", - "type": "Interface", - "label": "MlSummaryJob", - "description": [], - "tags": [], - "children": [ - { - "tags": [], - "id": "def-server.MlSummaryJob.id", - "type": "string", - "label": "id", - "description": [], - "source": { - "path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/summary_job.ts", - "lineNumber": 15 - } - }, - { - "tags": [], - "id": "def-server.MlSummaryJob.description", - "type": "string", - "label": "description", - "description": [], - "source": { - "path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/summary_job.ts", - "lineNumber": 16 - } - }, - { - "tags": [], - "id": "def-server.MlSummaryJob.groups", - "type": "Array", - "label": "groups", - "description": [], - "source": { - "path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/summary_job.ts", - "lineNumber": 17 - }, - "signature": [ - "string[]" - ] - }, - { - "tags": [], - "id": "def-server.MlSummaryJob.processed_record_count", - "type": "number", - "label": "processed_record_count", - "description": [], - "source": { - "path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/summary_job.ts", - "lineNumber": 18 - }, - "signature": [ - "number | undefined" - ] - }, - { - "tags": [], - "id": "def-server.MlSummaryJob.memory_status", - "type": "string", - "label": "memory_status", - "description": [], - "source": { - "path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/summary_job.ts", - "lineNumber": 19 - }, - "signature": [ - "string | undefined" - ] - }, - { - "tags": [], - "id": "def-server.MlSummaryJob.jobState", - "type": "string", - "label": "jobState", + "id": "def-server.MlSummaryJob.jobState", + "type": "string", + "label": "jobState", "description": [], "source": { "path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/summary_job.ts", - "lineNumber": 20 + "lineNumber": 21 } }, { @@ -3275,7 +2758,7 @@ "description": [], "source": { "path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/summary_job.ts", - "lineNumber": 21 + "lineNumber": 22 }, "signature": [ "string[]" @@ -3289,7 +2772,7 @@ "description": [], "source": { "path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/summary_job.ts", - "lineNumber": 22 + "lineNumber": 23 } }, { @@ -3300,7 +2783,7 @@ "description": [], "source": { "path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/summary_job.ts", - "lineNumber": 23 + "lineNumber": 24 } }, { @@ -3311,7 +2794,7 @@ "description": [], "source": { "path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/summary_job.ts", - "lineNumber": 24 + "lineNumber": 25 } }, { @@ -3322,7 +2805,7 @@ "description": [], "source": { "path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/summary_job.ts", - "lineNumber": 25 + "lineNumber": 26 }, "signature": [ "number | undefined" @@ -3336,7 +2819,7 @@ "description": [], "source": { "path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/summary_job.ts", - "lineNumber": 26 + "lineNumber": 27 }, "signature": [ "number | undefined" @@ -3350,7 +2833,7 @@ "description": [], "source": { "path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/summary_job.ts", - "lineNumber": 27 + "lineNumber": 28 }, "signature": [ "number | undefined" @@ -3364,7 +2847,7 @@ "description": [], "source": { "path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/summary_job.ts", - "lineNumber": 28 + "lineNumber": 29 }, "signature": [ "CombinedJob", @@ -3379,7 +2862,7 @@ "description": [], "source": { "path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/summary_job.ts", - "lineNumber": 29 + "lineNumber": 30 }, "signature": [ "string | undefined" @@ -3393,7 +2876,7 @@ "description": [], "source": { "path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/summary_job.ts", - "lineNumber": 30 + "lineNumber": 31 }, "signature": [ "Partial<", @@ -3409,7 +2892,7 @@ "description": [], "source": { "path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/summary_job.ts", - "lineNumber": 31 + "lineNumber": 32 } }, { @@ -3418,303 +2901,95 @@ "type": "string", "label": "isNotSingleMetricViewerJobMessage", "description": [], - "source": { - "path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/summary_job.ts", - "lineNumber": 32 - }, - "signature": [ - "string | undefined" - ] - }, - { - "tags": [], - "id": "def-server.MlSummaryJob.deleting", - "type": "CompoundType", - "label": "deleting", - "description": [], "source": { "path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/summary_job.ts", "lineNumber": 33 - }, - "signature": [ - "boolean | undefined" - ] - }, - { - "tags": [], - "id": "def-server.MlSummaryJob.latestTimestampSortValue", - "type": "number", - "label": "latestTimestampSortValue", - "description": [], - "source": { - "path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/summary_job.ts", - "lineNumber": 34 - }, - "signature": [ - "number | undefined" - ] - }, - { - "tags": [], - "id": "def-server.MlSummaryJob.earliestStartTimestampMs", - "type": "number", - "label": "earliestStartTimestampMs", - "description": [], - "source": { - "path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/summary_job.ts", - "lineNumber": 35 - }, - "signature": [ - "number | undefined" - ] - }, - { - "tags": [], - "id": "def-server.MlSummaryJob.awaitingNodeAssignment", - "type": "boolean", - "label": "awaitingNodeAssignment", - "description": [], - "source": { - "path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/summary_job.ts", - "lineNumber": 36 - } - } - ], - "source": { - "path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/summary_job.ts", - "lineNumber": 14 - }, - "initialIsOpen": false - }, - { - "id": "def-server.ModelSizeStats", - "type": "Interface", - "label": "ModelSizeStats", - "description": [], - "tags": [], - "children": [ - { - "tags": [], - "id": "def-server.ModelSizeStats.job_id", - "type": "string", - "label": "job_id", - "description": [], - "source": { - "path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/job_stats.ts", - "lineNumber": 44 - } - }, - { - "tags": [], - "id": "def-server.ModelSizeStats.result_type", - "type": "string", - "label": "result_type", - "description": [], - "source": { - "path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/job_stats.ts", - "lineNumber": 45 - } - }, - { - "tags": [], - "id": "def-server.ModelSizeStats.model_bytes", - "type": "number", - "label": "model_bytes", - "description": [], - "source": { - "path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/job_stats.ts", - "lineNumber": 46 - } - }, - { - "tags": [], - "id": "def-server.ModelSizeStats.model_bytes_exceeded", - "type": "number", - "label": "model_bytes_exceeded", - "description": [], - "source": { - "path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/job_stats.ts", - "lineNumber": 47 - } - }, - { - "tags": [], - "id": "def-server.ModelSizeStats.model_bytes_memory_limit", - "type": "number", - "label": "model_bytes_memory_limit", - "description": [], - "source": { - "path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/job_stats.ts", - "lineNumber": 48 - } - }, - { - "tags": [], - "id": "def-server.ModelSizeStats.peak_model_bytes", - "type": "number", - "label": "peak_model_bytes", - "description": [], - "source": { - "path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/job_stats.ts", - "lineNumber": 49 - }, - "signature": [ - "number | undefined" - ] - }, - { - "tags": [], - "id": "def-server.ModelSizeStats.total_by_field_count", - "type": "number", - "label": "total_by_field_count", - "description": [], - "source": { - "path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/job_stats.ts", - "lineNumber": 50 - } - }, - { - "tags": [], - "id": "def-server.ModelSizeStats.total_over_field_count", - "type": "number", - "label": "total_over_field_count", - "description": [], - "source": { - "path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/job_stats.ts", - "lineNumber": 51 - } - }, - { - "tags": [], - "id": "def-server.ModelSizeStats.total_partition_field_count", - "type": "number", - "label": "total_partition_field_count", - "description": [], - "source": { - "path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/job_stats.ts", - "lineNumber": 52 - } - }, - { - "tags": [], - "id": "def-server.ModelSizeStats.bucket_allocation_failures_count", - "type": "number", - "label": "bucket_allocation_failures_count", - "description": [], - "source": { - "path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/job_stats.ts", - "lineNumber": 53 - } - }, - { - "tags": [], - "id": "def-server.ModelSizeStats.memory_status", - "type": "CompoundType", - "label": "memory_status", - "description": [], - "source": { - "path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/job_stats.ts", - "lineNumber": 54 - }, - "signature": [ - "\"ok\" | \"soft_limit\" | \"hard_limit\"" - ] - }, - { - "tags": [], - "id": "def-server.ModelSizeStats.categorized_doc_count", - "type": "number", - "label": "categorized_doc_count", - "description": [], - "source": { - "path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/job_stats.ts", - "lineNumber": 55 - } - }, - { - "tags": [], - "id": "def-server.ModelSizeStats.total_category_count", - "type": "number", - "label": "total_category_count", - "description": [], - "source": { - "path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/job_stats.ts", - "lineNumber": 56 - } - }, - { - "tags": [], - "id": "def-server.ModelSizeStats.frequent_category_count", - "type": "number", - "label": "frequent_category_count", - "description": [], - "source": { - "path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/job_stats.ts", - "lineNumber": 57 - } + }, + "signature": [ + "string | undefined" + ] }, { "tags": [], - "id": "def-server.ModelSizeStats.rare_category_count", - "type": "number", - "label": "rare_category_count", + "id": "def-server.MlSummaryJob.deleting", + "type": "CompoundType", + "label": "deleting", "description": [], "source": { - "path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/job_stats.ts", - "lineNumber": 58 - } + "path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/summary_job.ts", + "lineNumber": 34 + }, + "signature": [ + "boolean | undefined" + ] }, { "tags": [], - "id": "def-server.ModelSizeStats.dead_category_count", + "id": "def-server.MlSummaryJob.latestTimestampSortValue", "type": "number", - "label": "dead_category_count", + "label": "latestTimestampSortValue", "description": [], "source": { - "path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/job_stats.ts", - "lineNumber": 59 - } + "path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/summary_job.ts", + "lineNumber": 35 + }, + "signature": [ + "number | undefined" + ] }, { "tags": [], - "id": "def-server.ModelSizeStats.categorization_status", - "type": "CompoundType", - "label": "categorization_status", + "id": "def-server.MlSummaryJob.earliestStartTimestampMs", + "type": "number", + "label": "earliestStartTimestampMs", "description": [], "source": { - "path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/job_stats.ts", - "lineNumber": 60 + "path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/summary_job.ts", + "lineNumber": 36 }, "signature": [ - "\"ok\" | \"warn\"" + "number | undefined" ] }, { "tags": [], - "id": "def-server.ModelSizeStats.log_time", - "type": "number", - "label": "log_time", + "id": "def-server.MlSummaryJob.awaitingNodeAssignment", + "type": "boolean", + "label": "awaitingNodeAssignment", "description": [], "source": { - "path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/job_stats.ts", - "lineNumber": 61 + "path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/summary_job.ts", + "lineNumber": 37 } }, { "tags": [], - "id": "def-server.ModelSizeStats.timestamp", - "type": "number", - "label": "timestamp", + "id": "def-server.MlSummaryJob.alertingRules", + "type": "Array", + "label": "alertingRules", "description": [], "source": { - "path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/job_stats.ts", - "lineNumber": 62 - } + "path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/summary_job.ts", + "lineNumber": 38 + }, + "signature": [ + "Pick<", + { + "pluginId": "alerting", + "scope": "common", + "docId": "kibAlertingPluginApi", + "section": "def-common.Alert", + "text": "Alert" + }, + "<", + "MlAnomalyDetectionAlertParams", + ">, \"enabled\" | \"id\" | \"name\" | \"params\" | \"actions\" | \"tags\" | \"muteAll\" | \"alertTypeId\" | \"consumer\" | \"schedule\" | \"scheduledTaskId\" | \"createdBy\" | \"updatedBy\" | \"createdAt\" | \"updatedAt\" | \"apiKeyOwner\" | \"throttle\" | \"notifyWhen\" | \"mutedInstanceIds\" | \"executionStatus\">[] | undefined" + ] } ], "source": { - "path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/job_stats.ts", - "lineNumber": 43 + "path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/summary_job.ts", + "lineNumber": 15 }, "initialIsOpen": false }, @@ -3794,7 +3069,7 @@ { "tags": [], "id": "def-server.ModelSnapshot.model_size_stats", - "type": "Object", + "type": "CompoundType", "label": "model_size_stats", "description": [], "source": { @@ -3845,78 +3120,6 @@ }, "initialIsOpen": false }, - { - "id": "def-server.Node", - "type": "Interface", - "label": "Node", - "description": [], - "tags": [], - "children": [ - { - "tags": [], - "id": "def-server.Node.id", - "type": "string", - "label": "id", - "description": [], - "source": { - "path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/job_stats.ts", - "lineNumber": 75 - } - }, - { - "tags": [], - "id": "def-server.Node.name", - "type": "string", - "label": "name", - "description": [], - "source": { - "path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/job_stats.ts", - "lineNumber": 76 - } - }, - { - "tags": [], - "id": "def-server.Node.ephemeral_id", - "type": "string", - "label": "ephemeral_id", - "description": [], - "source": { - "path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/job_stats.ts", - "lineNumber": 77 - } - }, - { - "tags": [], - "id": "def-server.Node.transport_address", - "type": "string", - "label": "transport_address", - "description": [], - "source": { - "path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/job_stats.ts", - "lineNumber": 78 - } - }, - { - "tags": [], - "id": "def-server.Node.attributes", - "type": "Object", - "label": "attributes", - "description": [], - "source": { - "path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/job_stats.ts", - "lineNumber": 79 - }, - "signature": [ - "{ 'transform.remote_connect'?: boolean | undefined; 'ml.machine_memory'?: number | undefined; 'xpack.installed'?: boolean | undefined; 'transform.node'?: boolean | undefined; 'ml.max_open_jobs'?: number | undefined; }" - ] - } - ], - "source": { - "path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/job_stats.ts", - "lineNumber": 74 - }, - "initialIsOpen": false - }, { "id": "def-server.PerPartitionCategorization", "type": "Interface", @@ -3932,7 +3135,7 @@ "description": [], "source": { "path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/job.ts", - "lineNumber": 106 + "lineNumber": 28 }, "signature": [ "boolean | undefined" @@ -3946,7 +3149,7 @@ "description": [], "source": { "path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/job.ts", - "lineNumber": 107 + "lineNumber": 29 }, "signature": [ "boolean | undefined" @@ -3955,7 +3158,7 @@ ], "source": { "path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/job.ts", - "lineNumber": 105 + "lineNumber": 27 }, "initialIsOpen": false } @@ -3970,10 +3173,10 @@ "description": [], "source": { "path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/datafeed.ts", - "lineNumber": 44 + "lineNumber": 16 }, "signature": [ - "{ [x: string]: { date_histogram: { field: string; fixed_interval: string;}; aggregations?: { [key: string]: any; } | undefined; aggs?: { [key: string]: any; } | undefined; }; }" + "{ [x: string]: estypes.AggregationContainer; }" ], "initialIsOpen": false }, @@ -3985,7 +3188,7 @@ "description": [], "source": { "path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/job.ts", - "lineNumber": 49 + "lineNumber": 15 }, "signature": [ "estypes.AnalysisConfig" @@ -4000,7 +3203,7 @@ "description": [], "source": { "path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/job.ts", - "lineNumber": 77 + "lineNumber": 19 }, "signature": [ "estypes.AnalysisLimits" @@ -4030,7 +3233,7 @@ "description": [], "source": { "path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/job.ts", - "lineNumber": 13 + "lineNumber": 11 }, "signature": [ "string" @@ -4045,7 +3248,7 @@ "description": [], "source": { "path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/datafeed.ts", - "lineNumber": 37 + "lineNumber": 14 }, "signature": [ "estypes.ChunkingConfig" @@ -4060,13 +3263,43 @@ "description": [], "source": { "path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/job.ts", - "lineNumber": 97 + "lineNumber": 25 }, "signature": [ "estypes.DetectionRule" ], "initialIsOpen": false }, + { + "id": "def-server.CustomSettings", + "type": "Type", + "label": "CustomSettings", + "tags": [], + "description": [], + "source": { + "path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/job.ts", + "lineNumber": 32 + }, + "signature": [ + "estypes.CustomSettings" + ], + "initialIsOpen": false + }, + { + "id": "def-server.DataCounts", + "type": "Type", + "label": "DataCounts", + "tags": [], + "description": [], + "source": { + "path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/job_stats.ts", + "lineNumber": 15 + }, + "signature": [ + "estypes.DataCounts" + ], + "initialIsOpen": false + }, { "id": "def-server.DataDescription", "type": "Type", @@ -4075,7 +3308,7 @@ "description": [], "source": { "path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/job.ts", - "lineNumber": 83 + "lineNumber": 21 }, "signature": [ "estypes.DataDescription" @@ -4090,7 +3323,7 @@ "description": [], "source": { "path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/datafeed.ts", - "lineNumber": 14 + "lineNumber": 12 }, "signature": [ "estypes.Datafeed" @@ -4105,13 +3338,28 @@ "description": [], "source": { "path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/datafeed.ts", - "lineNumber": 12 + "lineNumber": 10 }, "signature": [ "string" ], "initialIsOpen": false }, + { + "id": "def-server.DatafeedStats", + "type": "Type", + "label": "DatafeedStats", + "tags": [], + "description": [], + "source": { + "path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/datafeed_stats.ts", + "lineNumber": 10 + }, + "signature": [ + "estypes.DatafeedStats" + ], + "initialIsOpen": false + }, { "id": "def-server.DatafeedWithStats", "type": "Type", @@ -4120,11 +3368,12 @@ "description": [], "source": { "path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/combined_job.ts", - "lineNumber": 14 + "lineNumber": 15 }, "signature": [ "Datafeed", - " & DatafeedStats" + " & ", + "DatafeedStats" ], "initialIsOpen": false }, @@ -4136,7 +3385,7 @@ "description": [], "source": { "path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/job.ts", - "lineNumber": 63 + "lineNumber": 17 }, "signature": [ "estypes.Detector" @@ -4158,6 +3407,21 @@ ], "initialIsOpen": false }, + { + "id": "def-server.ForecastsStats", + "type": "Type", + "label": "ForecastsStats", + "tags": [], + "description": [], + "source": { + "path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/job_stats.ts", + "lineNumber": 27 + }, + "signature": [ + "estypes.JobForecastStatistics" + ], + "initialIsOpen": false + }, { "id": "def-server.IndicesOptions", "type": "Type", @@ -4166,7 +3430,7 @@ "description": [], "source": { "path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/datafeed.ts", - "lineNumber": 56 + "lineNumber": 18 }, "signature": [ "estypes.IndicesOptions" @@ -4181,7 +3445,7 @@ "description": [], "source": { "path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/job.ts", - "lineNumber": 23 + "lineNumber": 13 }, "signature": [ "estypes.Job" @@ -4196,13 +3460,28 @@ "description": [], "source": { "path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/job.ts", - "lineNumber": 12 + "lineNumber": 10 }, "signature": [ "string" ], "initialIsOpen": false }, + { + "id": "def-server.JobStats", + "type": "Type", + "label": "JobStats", + "tags": [], + "description": [], + "source": { + "path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/job_stats.ts", + "lineNumber": 10 + }, + "signature": [ + "estypes.JobStats & { model_size_stats: ModelSizeStats; timing_stats: TimingStats; }" + ], + "initialIsOpen": false + }, { "id": "def-server.JobWithStats", "type": "Type", @@ -4211,11 +3490,17 @@ "description": [], "source": { "path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/combined_job.ts", - "lineNumber": 13 + "lineNumber": 14 }, "signature": [ "Job", - " & JobStats" + " & ", + "JobStats", + " & { model_size_stats: ", + "ModelSizeStats", + "; timing_stats: ", + "TimingStats", + "; } & JobAlertingRuleStats" ], "initialIsOpen": false }, @@ -4227,7 +3512,7 @@ "description": [], "source": { "path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/summary_job.ts", - "lineNumber": 48 + "lineNumber": 50 }, "signature": [ "MlSummaryJob[]" @@ -4242,13 +3527,28 @@ "description": [], "source": { "path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/job.ts", - "lineNumber": 90 + "lineNumber": 23 }, "signature": [ "estypes.ModelPlotConfig" ], "initialIsOpen": false }, + { + "id": "def-server.ModelSizeStats", + "type": "Type", + "label": "ModelSizeStats", + "tags": [], + "description": [], + "source": { + "path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/job_stats.ts", + "lineNumber": 17 + }, + "signature": [ + "estypes.ModelSizeStats & { model_bytes_exceeded: number; model_bytes_memory_limit: number; peak_model_bytes?: number | undefined; }" + ], + "initialIsOpen": false + }, { "id": "def-server.ModuleSetupPayload", "type": "Type", @@ -4264,6 +3564,21 @@ ], "initialIsOpen": false }, + { + "id": "def-server.Node", + "type": "Type", + "label": "Node", + "tags": [], + "description": [], + "source": { + "path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/job_stats.ts", + "lineNumber": 29 + }, + "signature": [ + "estypes.DiscoveryNode" + ], + "initialIsOpen": false + }, { "id": "def-server.PartitionFieldsType", "type": "Type", @@ -4278,6 +3593,21 @@ "\"partition_field\" | \"over_field\" | \"by_field\"" ], "initialIsOpen": false + }, + { + "id": "def-server.TimingStats", + "type": "Type", + "label": "TimingStats", + "tags": [], + "description": [], + "source": { + "path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/job_stats.ts", + "lineNumber": 23 + }, + "signature": [ + "estypes.TimingStats & { total_bucket_processing_time_ms: number; }" + ], + "initialIsOpen": false } ], "objects": [], @@ -4289,7 +3619,7 @@ "description": [], "source": { "path": "x-pack/plugins/ml/server/plugin.ts", - "lineNumber": 63 + "lineNumber": 64 }, "signature": [ "JobServiceProvider", @@ -4313,7 +3643,7 @@ "description": [], "source": { "path": "x-pack/plugins/ml/server/plugin.ts", - "lineNumber": 64 + "lineNumber": 65 }, "signature": [ "void" @@ -4347,7 +3677,7 @@ "description": [], "source": { "path": "x-pack/plugins/ml/common/util/validators.ts", - "lineNumber": 51 + "lineNumber": 52 } } ], @@ -4355,7 +3685,7 @@ "returnComment": [], "source": { "path": "x-pack/plugins/ml/common/util/validators.ts", - "lineNumber": 50 + "lineNumber": 51 }, "initialIsOpen": false }, @@ -4374,7 +3704,7 @@ "description": [], "source": { "path": "x-pack/plugins/ml/common/util/errors/process_errors.ts", - "lineNumber": 97 + "lineNumber": 106 } } ], @@ -4387,7 +3717,7 @@ "label": "extractErrorMessage", "source": { "path": "x-pack/plugins/ml/common/util/errors/process_errors.ts", - "lineNumber": 97 + "lineNumber": 106 }, "tags": [], "returnComment": [], @@ -4596,7 +3926,7 @@ "description": [], "source": { "path": "x-pack/plugins/ml/common/util/validators.ts", - "lineNumber": 34 + "lineNumber": 35 } } ], @@ -4604,7 +3934,7 @@ "returnComment": [], "source": { "path": "x-pack/plugins/ml/common/util/validators.ts", - "lineNumber": 33 + "lineNumber": 34 }, "initialIsOpen": false } @@ -4664,7 +3994,7 @@ "description": [], "source": { "path": "x-pack/plugins/ml/common/types/fields.ts", - "lineNumber": 111 + "lineNumber": 115 }, "signature": [ "{ [x: string]: estypes.RuntimeField; }" diff --git a/api_docs/monitoring.json b/api_docs/monitoring.json index 831e4015cd842..1595f11bdcb7a 100644 --- a/api_docs/monitoring.json +++ b/api_docs/monitoring.json @@ -27,7 +27,7 @@ "description": [], "source": { "path": "x-pack/plugins/monitoring/server/types.ts", - "lineNumber": 94 + "lineNumber": 95 }, "signature": [ "() => any" @@ -41,7 +41,7 @@ "description": [], "source": { "path": "x-pack/plugins/monitoring/server/types.ts", - "lineNumber": 95 + "lineNumber": 96 }, "signature": [ "() => void" @@ -55,7 +55,7 @@ "description": [], "source": { "path": "x-pack/plugins/monitoring/server/types.ts", - "lineNumber": 96 + "lineNumber": 97 }, "signature": [ "(esClient: ", @@ -77,7 +77,7 @@ "description": [], "source": { "path": "x-pack/plugins/monitoring/server/types.ts", - "lineNumber": 97 + "lineNumber": 98 }, "signature": [ "() => void" @@ -86,7 +86,7 @@ ], "source": { "path": "x-pack/plugins/monitoring/server/types.ts", - "lineNumber": 93 + "lineNumber": 94 }, "initialIsOpen": false } @@ -116,12 +116,12 @@ "description": [], "source": { "path": "x-pack/plugins/monitoring/server/config.ts", - "lineNumber": 92 + "lineNumber": 93 }, "signature": [ - "{ ui: { elasticsearch: MonitoringElasticsearchConfig; enabled: boolean; container: Readonly<{} & { logstash: Readonly<{} & { enabled: boolean; }>; elasticsearch: Readonly<{} & { enabled: boolean; }>; apm: Readonly<{} & { enabled: boolean; }>; }>; logs: Readonly<{} & { index: string; }>; ccs: Readonly<{} & { enabled: boolean; }>; metricbeat: Readonly<{} & { index: string; }>; max_bucket_size: number; min_interval_seconds: number; show_license_expiration: boolean; }; enabled: boolean; kibana: Readonly<{} & { collection: Readonly<{} & { enabled: boolean; interval: number; }>; }>; licensing: Readonly<{} & { api_polling_frequency: ", + "{ ui: { elasticsearch: MonitoringElasticsearchConfig; enabled: boolean; container: Readonly<{} & { logstash: Readonly<{} & { enabled: boolean; }>; elasticsearch: Readonly<{} & { enabled: boolean; }>; apm: Readonly<{} & { enabled: boolean; }>; }>; logs: Readonly<{} & { index: string; }>; metricbeat: Readonly<{} & { index: string; }>; ccs: Readonly<{} & { enabled: boolean; }>; max_bucket_size: number; min_interval_seconds: number; show_license_expiration: boolean; }; enabled: boolean; kibana: Readonly<{} & { collection: Readonly<{} & { enabled: boolean; interval: number; }>; }>; agent: Readonly<{} & { interval: string; }>; licensing: Readonly<{} & { api_polling_frequency: ", "Duration", - "; }>; agent: Readonly<{} & { interval: string; }>; cluster_alerts: Readonly<{} & { enabled: boolean; email_notifications: Readonly<{} & { enabled: boolean; email_address: string; }>; }>; tests: Readonly<{} & { cloud_detector: Readonly<{} & { enabled: boolean; }>; }>; }" + "; }>; cluster_alerts: Readonly<{} & { enabled: boolean; allowedSpaces: string[]; email_notifications: Readonly<{} & { enabled: boolean; email_address: string; }>; }>; tests: Readonly<{} & { cloud_detector: Readonly<{} & { enabled: boolean; }>; }>; }" ], "initialIsOpen": false } @@ -142,7 +142,7 @@ "description": [], "source": { "path": "x-pack/plugins/monitoring/server/types.ts", - "lineNumber": 101 + "lineNumber": 102 }, "signature": [ "() => any" @@ -151,7 +151,7 @@ ], "source": { "path": "x-pack/plugins/monitoring/server/types.ts", - "lineNumber": 100 + "lineNumber": 101 }, "lifecycle": "setup", "initialIsOpen": true diff --git a/api_docs/observability.json b/api_docs/observability.json index e35a98a31aa00..17bd8d39846e3 100644 --- a/api_docs/observability.json +++ b/api_docs/observability.json @@ -1,7 +1,39 @@ { "id": "observability", "client": { - "classes": [], + "classes": [ + { + "id": "def-public.FormatterRuleRegistry", + "type": "Class", + "tags": [], + "label": "FormatterRuleRegistry", + "description": [], + "signature": [ + { + "pluginId": "observability", + "scope": "public", + "docId": "kibObservabilityPluginApi", + "section": "def-public.FormatterRuleRegistry", + "text": "FormatterRuleRegistry" + }, + " extends ", + { + "pluginId": "ruleRegistry", + "scope": "public", + "docId": "kibRuleRegistryPluginApi", + "section": "def-public.RuleRegistry", + "text": "RuleRegistry" + }, + ">" + ], + "children": [], + "source": { + "path": "x-pack/plugins/observability/public/rules/formatter_rule_registry.ts", + "lineNumber": 27 + }, + "initialIsOpen": false + } + ], "functions": [ { "id": "def-public.ActionMenu", @@ -58,7 +90,13 @@ "label": "createExploratoryViewUrl", "signature": [ "(allSeries: Record, baseHref: string) => string" ], "description": [], @@ -70,13 +108,19 @@ "isRequired": true, "signature": [ "Record" ], "description": [], "source": { "path": "x-pack/plugins/observability/public/components/shared/exploratory_view/configurations/utils.ts", - "lineNumber": 36 + "lineNumber": 38 } }, { @@ -90,7 +134,7 @@ "description": [], "source": { "path": "x-pack/plugins/observability/public/components/shared/exploratory_view/configurations/utils.ts", - "lineNumber": 36 + "lineNumber": 38 } } ], @@ -98,7 +142,7 @@ "returnComment": [], "source": { "path": "x-pack/plugins/observability/public/components/shared/exploratory_view/configurations/utils.ts", - "lineNumber": 36 + "lineNumber": 38 }, "initialIsOpen": false }, @@ -115,7 +159,7 @@ "children": [ { "id": "def-public.FieldValueSuggestions.$1", - "type": "Object", + "type": "CompoundType", "label": "props", "isRequired": true, "signature": [ @@ -496,7 +540,7 @@ "type": "Function", "label": "useFetcher", "signature": [ - "(fn: () => TReturn, fnDeps: any[], options: { preservePreviousData?: boolean | undefined; }) => ", + "(fn: ({}: { signal: AbortSignal; }) => TReturn, fnDeps: any[], options: { preservePreviousData?: boolean | undefined; }) => ", "FetcherResult", "> & { refetch: () => void; }" ], @@ -508,7 +552,7 @@ "label": "fn", "isRequired": true, "signature": [ - "() => TReturn" + "({}: { signal: AbortSignal; }) => TReturn" ], "description": [], "source": { @@ -701,7 +745,7 @@ "type": "Function", "label": "useUiTracker", "signature": [ - "({\n app: defaultApp,\n}: { app?: \"uptime\" | \"apm\" | \"infra_metrics\" | \"infra_logs\" | \"observability-overview\" | \"stack_monitoring\" | \"ux\" | undefined; }) => ({ app, metric, metricType }: ", + "({\n app: defaultApp,\n}: { app?: \"apm\" | \"uptime\" | \"fleet\" | \"infra_metrics\" | \"infra_logs\" | \"synthetics\" | \"observability-overview\" | \"stack_monitoring\" | \"ux\" | undefined; }) => ({ app, metric, metricType }: ", { "pluginId": "observability", "scope": "public", @@ -731,7 +775,7 @@ "lineNumber": 40 }, "signature": [ - "\"uptime\" | \"apm\" | \"infra_metrics\" | \"infra_logs\" | \"observability-overview\" | \"stack_monitoring\" | \"ux\" | undefined" + "\"apm\" | \"uptime\" | \"fleet\" | \"infra_metrics\" | \"infra_logs\" | \"synthetics\" | \"observability-overview\" | \"stack_monitoring\" | \"ux\" | undefined" ] } ], @@ -783,7 +827,7 @@ "description": [], "source": { "path": "x-pack/plugins/observability/public/typings/fetch_overview_data/index.ts", - "lineNumber": 111 + "lineNumber": 115 }, "signature": [ "{ services: ", @@ -813,7 +857,7 @@ "description": [], "source": { "path": "x-pack/plugins/observability/public/typings/fetch_overview_data/index.ts", - "lineNumber": 115 + "lineNumber": 119 }, "signature": [ "{ transactions: ", @@ -830,7 +874,35 @@ ], "source": { "path": "x-pack/plugins/observability/public/typings/fetch_overview_data/index.ts", - "lineNumber": 110 + "lineNumber": 114 + }, + "initialIsOpen": false + }, + { + "id": "def-public.ConfigSchema", + "type": "Interface", + "label": "ConfigSchema", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-public.ConfigSchema.unsafe", + "type": "Object", + "label": "unsafe", + "description": [], + "source": { + "path": "x-pack/plugins/observability/public/index.ts", + "lineNumber": 25 + }, + "signature": [ + "{ alertingExperience: { enabled: boolean; }; }" + ] + } + ], + "source": { + "path": "x-pack/plugins/observability/public/index.ts", + "lineNumber": 24 }, "initialIsOpen": false }, @@ -898,7 +970,7 @@ "description": [], "source": { "path": "x-pack/plugins/observability/public/typings/fetch_overview_data/index.ts", - "lineNumber": 56 + "lineNumber": 60 }, "signature": [ { @@ -927,7 +999,7 @@ "description": [], "source": { "path": "x-pack/plugins/observability/public/typings/fetch_overview_data/index.ts", - "lineNumber": 57 + "lineNumber": 61 }, "signature": [ { @@ -943,7 +1015,7 @@ ], "source": { "path": "x-pack/plugins/observability/public/typings/fetch_overview_data/index.ts", - "lineNumber": 53 + "lineNumber": 57 }, "initialIsOpen": false }, @@ -1029,13 +1101,13 @@ "description": [], "source": { "path": "x-pack/plugins/observability/public/typings/fetch_overview_data/index.ts", - "lineNumber": 61 + "lineNumber": 65 } } ], "source": { "path": "x-pack/plugins/observability/public/typings/fetch_overview_data/index.ts", - "lineNumber": 60 + "lineNumber": 64 }, "initialIsOpen": false }, @@ -1067,6 +1139,42 @@ }, "initialIsOpen": false }, + { + "id": "def-public.HasDataResponse", + "type": "Interface", + "label": "HasDataResponse", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-public.HasDataResponse.hasData", + "type": "boolean", + "label": "hasData", + "description": [], + "source": { + "path": "x-pack/plugins/observability/public/typings/fetch_overview_data/index.ts", + "lineNumber": 36 + } + }, + { + "tags": [], + "id": "def-public.HasDataResponse.indices", + "type": "string", + "label": "indices", + "description": [], + "source": { + "path": "x-pack/plugins/observability/public/typings/fetch_overview_data/index.ts", + "lineNumber": 37 + } + } + ], + "source": { + "path": "x-pack/plugins/observability/public/typings/fetch_overview_data/index.ts", + "lineNumber": 35 + }, + "initialIsOpen": false + }, { "id": "def-public.LogsFetchDataResponse", "type": "Interface", @@ -1099,7 +1207,7 @@ "description": [], "source": { "path": "x-pack/plugins/observability/public/typings/fetch_overview_data/index.ts", - "lineNumber": 65 + "lineNumber": 69 }, "signature": [ "Record Promise<", @@ -1196,7 +1304,7 @@ "description": [], "source": { "path": "x-pack/plugins/observability/public/typings/fetch_overview_data/index.ts", - "lineNumber": 95 + "lineNumber": 99 }, "signature": [ { @@ -1212,7 +1320,7 @@ ], "source": { "path": "x-pack/plugins/observability/public/typings/fetch_overview_data/index.ts", - "lineNumber": 93 + "lineNumber": 97 }, "initialIsOpen": false }, @@ -1231,7 +1339,7 @@ "description": [], "source": { "path": "x-pack/plugins/observability/public/typings/fetch_overview_data/index.ts", - "lineNumber": 73 + "lineNumber": 77 } }, { @@ -1242,7 +1350,7 @@ "description": [], "source": { "path": "x-pack/plugins/observability/public/typings/fetch_overview_data/index.ts", - "lineNumber": 74 + "lineNumber": 78 }, "signature": [ "string | null" @@ -1256,7 +1364,7 @@ "description": [], "source": { "path": "x-pack/plugins/observability/public/typings/fetch_overview_data/index.ts", - "lineNumber": 75 + "lineNumber": 79 }, "signature": [ "string | null" @@ -1270,7 +1378,7 @@ "description": [], "source": { "path": "x-pack/plugins/observability/public/typings/fetch_overview_data/index.ts", - "lineNumber": 76 + "lineNumber": 80 }, "signature": [ "string | null" @@ -1284,7 +1392,7 @@ "description": [], "source": { "path": "x-pack/plugins/observability/public/typings/fetch_overview_data/index.ts", - "lineNumber": 77 + "lineNumber": 81 }, "signature": [ "number | null" @@ -1298,7 +1406,7 @@ "description": [], "source": { "path": "x-pack/plugins/observability/public/typings/fetch_overview_data/index.ts", - "lineNumber": 78 + "lineNumber": 82 }, "signature": [ "number | null" @@ -1312,7 +1420,7 @@ "description": [], "source": { "path": "x-pack/plugins/observability/public/typings/fetch_overview_data/index.ts", - "lineNumber": 79 + "lineNumber": 83 }, "signature": [ "number | null" @@ -1326,7 +1434,7 @@ "description": [], "source": { "path": "x-pack/plugins/observability/public/typings/fetch_overview_data/index.ts", - "lineNumber": 80 + "lineNumber": 84 }, "signature": [ "number | null" @@ -1340,7 +1448,7 @@ "description": [], "source": { "path": "x-pack/plugins/observability/public/typings/fetch_overview_data/index.ts", - "lineNumber": 81 + "lineNumber": 85 }, "signature": [ "number | null" @@ -1354,7 +1462,7 @@ "description": [], "source": { "path": "x-pack/plugins/observability/public/typings/fetch_overview_data/index.ts", - "lineNumber": 82 + "lineNumber": 86 }, "signature": [ "number | null" @@ -1368,7 +1476,7 @@ "description": [], "source": { "path": "x-pack/plugins/observability/public/typings/fetch_overview_data/index.ts", - "lineNumber": 83 + "lineNumber": 87 }, "signature": [ "{ timestamp: number; cpu: number | null; iowait: number | null; load: number | null; rx: number | null; tx: number | null; }[]" @@ -1377,7 +1485,7 @@ ], "source": { "path": "x-pack/plugins/observability/public/typings/fetch_overview_data/index.ts", - "lineNumber": 72 + "lineNumber": 76 }, "initialIsOpen": false }, @@ -1396,7 +1504,7 @@ "description": [], "source": { "path": "x-pack/plugins/observability/public/typings/fetch_overview_data/index.ts", - "lineNumber": 125 + "lineNumber": 129 }, "signature": [ { @@ -1416,7 +1524,7 @@ "description": [], "source": { "path": "x-pack/plugins/observability/public/typings/fetch_overview_data/index.ts", - "lineNumber": 126 + "lineNumber": 130 }, "signature": [ { @@ -1436,7 +1544,7 @@ "description": [], "source": { "path": "x-pack/plugins/observability/public/typings/fetch_overview_data/index.ts", - "lineNumber": 127 + "lineNumber": 131 }, "signature": [ { @@ -1450,13 +1558,13 @@ }, { "tags": [], - "id": "def-public.ObservabilityFetchDataResponse.uptime", + "id": "def-public.ObservabilityFetchDataResponse.synthetics", "type": "Object", - "label": "uptime", + "label": "synthetics", "description": [], "source": { "path": "x-pack/plugins/observability/public/typings/fetch_overview_data/index.ts", - "lineNumber": 128 + "lineNumber": 132 }, "signature": [ { @@ -1476,7 +1584,7 @@ "description": [], "source": { "path": "x-pack/plugins/observability/public/typings/fetch_overview_data/index.ts", - "lineNumber": 129 + "lineNumber": 133 }, "signature": [ { @@ -1491,7 +1599,7 @@ ], "source": { "path": "x-pack/plugins/observability/public/typings/fetch_overview_data/index.ts", - "lineNumber": 124 + "lineNumber": 128 }, "initialIsOpen": false }, @@ -1510,7 +1618,7 @@ "description": [], "source": { "path": "x-pack/plugins/observability/public/typings/fetch_overview_data/index.ts", - "lineNumber": 133 + "lineNumber": 137 } }, { @@ -1521,7 +1629,7 @@ "description": [], "source": { "path": "x-pack/plugins/observability/public/typings/fetch_overview_data/index.ts", - "lineNumber": 134 + "lineNumber": 138 } }, { @@ -1532,19 +1640,28 @@ "description": [], "source": { "path": "x-pack/plugins/observability/public/typings/fetch_overview_data/index.ts", - "lineNumber": 135 + "lineNumber": 139 } }, { "tags": [], - "id": "def-public.ObservabilityHasDataResponse.uptime", - "type": "boolean", - "label": "uptime", + "id": "def-public.ObservabilityHasDataResponse.synthetics", + "type": "Object", + "label": "synthetics", "description": [], "source": { "path": "x-pack/plugins/observability/public/typings/fetch_overview_data/index.ts", - "lineNumber": 136 - } + "lineNumber": 140 + }, + "signature": [ + { + "pluginId": "observability", + "scope": "public", + "docId": "kibObservabilityPluginApi", + "section": "def-public.HasDataResponse", + "text": "HasDataResponse" + } + ] }, { "tags": [], @@ -1554,7 +1671,7 @@ "description": [], "source": { "path": "x-pack/plugins/observability/public/typings/fetch_overview_data/index.ts", - "lineNumber": 137 + "lineNumber": 141 }, "signature": [ { @@ -1569,7 +1686,7 @@ ], "source": { "path": "x-pack/plugins/observability/public/typings/fetch_overview_data/index.ts", - "lineNumber": 132 + "lineNumber": 136 }, "initialIsOpen": false }, @@ -1588,7 +1705,7 @@ "description": [], "source": { "path": "x-pack/plugins/observability/public/plugin.ts", - "lineNumber": 30 + "lineNumber": 41 }, "signature": [ { @@ -1600,6 +1717,36 @@ } ] }, + { + "tags": [], + "id": "def-public.ObservabilityPublicPluginsSetup.ruleRegistry", + "type": "Object", + "label": "ruleRegistry", + "description": [], + "source": { + "path": "x-pack/plugins/observability/public/plugin.ts", + "lineNumber": 42 + }, + "signature": [ + "{ registry: ", + { + "pluginId": "ruleRegistry", + "scope": "public", + "docId": "kibRuleRegistryPluginApi", + "section": "def-public.RuleRegistry", + "text": "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; }; }, ", + { + "pluginId": "triggersActionsUi", + "scope": "public", + "docId": "kibTriggersActionsUiPluginApi", + "section": "def-public.AlertTypeModel", + "text": "AlertTypeModel" + }, + ">>; }" + ] + }, { "tags": [], "id": "def-public.ObservabilityPublicPluginsSetup.home", @@ -1608,7 +1755,7 @@ "description": [], "source": { "path": "x-pack/plugins/observability/public/plugin.ts", - "lineNumber": 31 + "lineNumber": 43 }, "signature": [ { @@ -1624,7 +1771,7 @@ ], "source": { "path": "x-pack/plugins/observability/public/plugin.ts", - "lineNumber": 29 + "lineNumber": 40 }, "initialIsOpen": false }, @@ -1643,7 +1790,7 @@ "description": [], "source": { "path": "x-pack/plugins/observability/public/plugin.ts", - "lineNumber": 35 + "lineNumber": 47 }, "signature": [ { @@ -1664,7 +1811,7 @@ "description": [], "source": { "path": "x-pack/plugins/observability/public/plugin.ts", - "lineNumber": 36 + "lineNumber": 48 }, "signature": [ { @@ -1684,7 +1831,7 @@ "description": [], "source": { "path": "x-pack/plugins/observability/public/plugin.ts", - "lineNumber": 37 + "lineNumber": 49 }, "signature": [ { @@ -1699,7 +1846,7 @@ ], "source": { "path": "x-pack/plugins/observability/public/plugin.ts", - "lineNumber": 34 + "lineNumber": 46 }, "initialIsOpen": false }, @@ -1738,6 +1885,133 @@ }, "initialIsOpen": false }, + { + "id": "def-public.SeriesUrl", + "type": "Interface", + "label": "SeriesUrl", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-public.SeriesUrl.time", + "type": "Object", + "label": "time", + "description": [], + "source": { + "path": "x-pack/plugins/observability/public/components/shared/exploratory_view/types.ts", + "lineNumber": 74 + }, + "signature": [ + "{ to: string; from: string; }" + ] + }, + { + "tags": [], + "id": "def-public.SeriesUrl.breakdown", + "type": "string", + "label": "breakdown", + "description": [], + "source": { + "path": "x-pack/plugins/observability/public/components/shared/exploratory_view/types.ts", + "lineNumber": 78 + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [], + "id": "def-public.SeriesUrl.filters", + "type": "Array", + "label": "filters", + "description": [], + "source": { + "path": "x-pack/plugins/observability/public/components/shared/exploratory_view/types.ts", + "lineNumber": 79 + }, + "signature": [ + "UrlFilter", + "[] | undefined" + ] + }, + { + "tags": [], + "id": "def-public.SeriesUrl.seriesType", + "type": "CompoundType", + "label": "seriesType", + "description": [], + "source": { + "path": "x-pack/plugins/observability/public/components/shared/exploratory_view/types.ts", + "lineNumber": 80 + }, + "signature": [ + "\"area\" | \"line\" | \"bar\" | \"bar_horizontal\" | \"bar_stacked\" | \"bar_percentage_stacked\" | \"bar_horizontal_stacked\" | \"bar_horizontal_percentage_stacked\" | \"area_stacked\" | \"area_percentage_stacked\" | undefined" + ] + }, + { + "tags": [], + "id": "def-public.SeriesUrl.reportType", + "type": "CompoundType", + "label": "reportType", + "description": [], + "source": { + "path": "x-pack/plugins/observability/public/components/shared/exploratory_view/types.ts", + "lineNumber": 81 + }, + "signature": [ + "\"logs\" | \"cpu\" | \"pld\" | \"kpi\" | \"upd\" | \"upp\" | \"svl\" | \"tpt\" | \"mem\" | \"nwk\"" + ] + }, + { + "tags": [], + "id": "def-public.SeriesUrl.operationType", + "type": "CompoundType", + "label": "operationType", + "description": [], + "source": { + "path": "x-pack/plugins/observability/public/components/shared/exploratory_view/types.ts", + "lineNumber": 82 + }, + "signature": [ + "\"range\" | \"filters\" | \"count\" | \"max\" | \"min\" | \"date_histogram\" | \"sum\" | \"average\" | \"percentile\" | \"terms\" | \"median\" | \"cumulative_sum\" | \"moving_average\" | \"counter_rate\" | \"differences\" | \"unique_count\" | \"last_value\" | undefined" + ] + }, + { + "tags": [], + "id": "def-public.SeriesUrl.dataType", + "type": "CompoundType", + "label": "dataType", + "description": [], + "source": { + "path": "x-pack/plugins/observability/public/components/shared/exploratory_view/types.ts", + "lineNumber": 83 + }, + "signature": [ + "AppDataType" + ] + }, + { + "tags": [], + "id": "def-public.SeriesUrl.reportDefinitions", + "type": "Object", + "label": "reportDefinitions", + "description": [], + "source": { + "path": "x-pack/plugins/observability/public/components/shared/exploratory_view/types.ts", + "lineNumber": 84 + }, + "signature": [ + "Record | undefined" + ] + } + ], + "source": { + "path": "x-pack/plugins/observability/public/components/shared/exploratory_view/types.ts", + "lineNumber": 73 + }, + "initialIsOpen": false + }, { "id": "def-public.Stat", "type": "Interface", @@ -1809,7 +2083,7 @@ "description": [], "source": { "path": "x-pack/plugins/observability/public/typings/fetch_overview_data/index.ts", - "lineNumber": 99 + "lineNumber": 103 }, "signature": [ "{ monitors: ", @@ -1847,7 +2121,7 @@ "description": [], "source": { "path": "x-pack/plugins/observability/public/typings/fetch_overview_data/index.ts", - "lineNumber": 104 + "lineNumber": 108 }, "signature": [ "{ up: ", @@ -1872,7 +2146,7 @@ ], "source": { "path": "x-pack/plugins/observability/public/typings/fetch_overview_data/index.ts", - "lineNumber": 98 + "lineNumber": 102 }, "initialIsOpen": false }, @@ -1908,7 +2182,7 @@ "description": [], "source": { "path": "x-pack/plugins/observability/public/typings/fetch_overview_data/index.ts", - "lineNumber": 121 + "lineNumber": 125 }, "signature": [ { @@ -1923,7 +2197,7 @@ ], "source": { "path": "x-pack/plugins/observability/public/typings/fetch_overview_data/index.ts", - "lineNumber": 120 + "lineNumber": 124 }, "initialIsOpen": false }, @@ -1931,20 +2205,26 @@ "id": "def-public.UXHasDataResponse", "type": "Interface", "label": "UXHasDataResponse", - "description": [], - "tags": [], - "children": [ + "signature": [ { - "tags": [], - "id": "def-public.UXHasDataResponse.hasData", - "type": "boolean", - "label": "hasData", - "description": [], - "source": { - "path": "x-pack/plugins/observability/public/typings/fetch_overview_data/index.ts", - "lineNumber": 36 - } + "pluginId": "observability", + "scope": "public", + "docId": "kibObservabilityPluginApi", + "section": "def-public.UXHasDataResponse", + "text": "UXHasDataResponse" }, + " extends ", + { + "pluginId": "observability", + "scope": "public", + "docId": "kibObservabilityPluginApi", + "section": "def-public.HasDataResponse", + "text": "HasDataResponse" + } + ], + "description": [], + "tags": [], + "children": [ { "tags": [], "id": "def-public.UXHasDataResponse.serviceName", @@ -1953,7 +2233,7 @@ "description": [], "source": { "path": "x-pack/plugins/observability/public/typings/fetch_overview_data/index.ts", - "lineNumber": 37 + "lineNumber": 41 }, "signature": [ "string | number | undefined" @@ -1962,7 +2242,7 @@ ], "source": { "path": "x-pack/plugins/observability/public/typings/fetch_overview_data/index.ts", - "lineNumber": 35 + "lineNumber": 40 }, "initialIsOpen": false }, @@ -2170,7 +2450,7 @@ "description": [], "source": { "path": "x-pack/plugins/observability/common/ui_settings_keys.ts", - "lineNumber": 9 + "lineNumber": 8 }, "signature": [ "\"observability:enableInspectEsQueries\"" @@ -2185,7 +2465,7 @@ "description": [], "source": { "path": "x-pack/plugins/observability/public/typings/fetch_overview_data/index.ts", - "lineNumber": 40 + "lineNumber": 44 }, "signature": [ "(fetchDataParams: ", @@ -2208,7 +2488,7 @@ "description": [], "source": { "path": "x-pack/plugins/observability/public/typings/fetch_overview_data/index.ts", - "lineNumber": 44 + "lineNumber": 48 }, "signature": [ "(params: ", @@ -2239,7 +2519,7 @@ "description": [], "source": { "path": "x-pack/plugins/observability/public/typings/fetch_overview_data/index.ts", - "lineNumber": 70 + "lineNumber": 74 }, "signature": [ "null | number" @@ -2254,10 +2534,10 @@ "description": [], "source": { "path": "x-pack/plugins/observability/public/typings/fetch_overview_data/index.ts", - "lineNumber": 48 + "lineNumber": 52 }, "signature": [ - "\"uptime\" | \"apm\" | \"infra_metrics\" | \"infra_logs\" | \"ux\"" + "\"apm\" | \"infra_metrics\" | \"infra_logs\" | \"synthetics\" | \"ux\"" ], "initialIsOpen": false }, @@ -2292,7 +2572,7 @@ "description": [], "source": { "path": "x-pack/plugins/observability/public/typings/fetch_overview_data/index.ts", - "lineNumber": 69 + "lineNumber": 73 }, "signature": [ "null | string" @@ -2341,32 +2621,17 @@ "objects": [], "setup": { "id": "def-public.ObservabilityPublicSetup", - "type": "Interface", + "type": "Type", "label": "ObservabilityPublicSetup", - "description": [], "tags": [], - "children": [ - { - "tags": [], - "id": "def-public.ObservabilityPublicSetup.dashboard", - "type": "Object", - "label": "dashboard", - "description": [], - "source": { - "path": "x-pack/plugins/observability/public/plugin.ts", - "lineNumber": 26 - }, - "signature": [ - "{ register: typeof ", - "registerDataHandler", - "; }" - ] - } - ], + "description": [], "source": { "path": "x-pack/plugins/observability/public/plugin.ts", - "lineNumber": 25 + "lineNumber": 37 }, + "signature": [ + "{ dashboard: { register: typeof registerDataHandler; }; 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; }; }>; isAlertingExperienceEnabled: () => boolean; }" + ], "lifecycle": "setup", "initialIsOpen": true }, @@ -2378,7 +2643,7 @@ "description": [], "source": { "path": "x-pack/plugins/observability/public/plugin.ts", - "lineNumber": 40 + "lineNumber": 52 }, "signature": [ "void" @@ -2574,6 +2839,102 @@ }, "initialIsOpen": false }, + { + "id": "def-server.kqlQuery", + "type": "Function", + "label": "kqlQuery", + "signature": [ + "(kql: string | undefined) => ", + "QueryContainer", + "[]" + ], + "description": [], + "children": [ + { + "id": "def-server.kqlQuery.$1", + "type": "string", + "label": "kql", + "isRequired": false, + "signature": [ + "string | undefined" + ], + "description": [], + "source": { + "path": "x-pack/plugins/observability/server/utils/queries.ts", + "lineNumber": 25 + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "x-pack/plugins/observability/server/utils/queries.ts", + "lineNumber": 25 + }, + "initialIsOpen": false + }, + { + "id": "def-server.rangeQuery", + "type": "Function", + "label": "rangeQuery", + "signature": [ + "(start: number, end: number, field: string) => ", + "QueryContainer", + "[]" + ], + "description": [], + "children": [ + { + "id": "def-server.rangeQuery.$1", + "type": "number", + "label": "start", + "isRequired": true, + "signature": [ + "number" + ], + "description": [], + "source": { + "path": "x-pack/plugins/observability/server/utils/queries.ts", + "lineNumber": 11 + } + }, + { + "id": "def-server.rangeQuery.$2", + "type": "number", + "label": "end", + "isRequired": true, + "signature": [ + "number" + ], + "description": [], + "source": { + "path": "x-pack/plugins/observability/server/utils/queries.ts", + "lineNumber": 11 + } + }, + { + "id": "def-server.rangeQuery.$3", + "type": "string", + "label": "field", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "x-pack/plugins/observability/server/utils/queries.ts", + "lineNumber": 11 + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "x-pack/plugins/observability/server/utils/queries.ts", + "lineNumber": 11 + }, + "initialIsOpen": false + }, { "id": "def-server.unwrapEsResponse", "type": "Function", @@ -2609,9 +2970,161 @@ "initialIsOpen": false } ], - "interfaces": [], + "interfaces": [ + { + "id": "def-server.ObservabilityRouteCreateOptions", + "type": "Interface", + "label": "ObservabilityRouteCreateOptions", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-server.ObservabilityRouteCreateOptions.options", + "type": "Object", + "label": "options", + "description": [], + "source": { + "path": "x-pack/plugins/observability/server/routes/types.ts", + "lineNumber": 34 + }, + "signature": [ + "{ tags: string[]; }" + ] + } + ], + "source": { + "path": "x-pack/plugins/observability/server/routes/types.ts", + "lineNumber": 33 + }, + "initialIsOpen": false + }, + { + "id": "def-server.ObservabilityRouteHandlerResources", + "type": "Interface", + "label": "ObservabilityRouteHandlerResources", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-server.ObservabilityRouteHandlerResources.core", + "type": "Object", + "label": "core", + "description": [], + "source": { + "path": "x-pack/plugins/observability/server/routes/types.ts", + "lineNumber": 23 + }, + "signature": [ + "{ start: () => Promise<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.CoreStart", + "text": "CoreStart" + }, + ">; setup: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.CoreSetup", + "text": "CoreSetup" + }, + "; }" + ] + }, + { + "tags": [], + "id": "def-server.ObservabilityRouteHandlerResources.ruleRegistry", + "type": "Object", + "label": "ruleRegistry", + "description": [], + "source": { + "path": "x-pack/plugins/observability/server/routes/types.ts", + "lineNumber": 27 + }, + "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; }; }>" + ] + }, + { + "tags": [], + "id": "def-server.ObservabilityRouteHandlerResources.request", + "type": "Object", + "label": "request", + "description": [], + "source": { + "path": "x-pack/plugins/observability/server/routes/types.ts", + "lineNumber": 28 + }, + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.KibanaRequest", + "text": "KibanaRequest" + }, + "" + ] + }, + { + "tags": [], + "id": "def-server.ObservabilityRouteHandlerResources.context", + "type": "Object", + "label": "context", + "description": [], + "source": { + "path": "x-pack/plugins/observability/server/routes/types.ts", + "lineNumber": 29 + }, + "signature": [ + "ObservabilityRequestHandlerContext" + ] + }, + { + "tags": [], + "id": "def-server.ObservabilityRouteHandlerResources.logger", + "type": "Object", + "label": "logger", + "description": [], + "source": { + "path": "x-pack/plugins/observability/server/routes/types.ts", + "lineNumber": 30 + }, + "signature": [ + "Logger" + ] + } + ], + "source": { + "path": "x-pack/plugins/observability/server/routes/types.ts", + "lineNumber": 22 + }, + "initialIsOpen": false + } + ], "enums": [], "misc": [ + { + "id": "def-server.AbstractObservabilityServerRouteRepository", + "type": "Type", + "label": "AbstractObservabilityServerRouteRepository", + "tags": [], + "description": [], + "source": { + "path": "x-pack/plugins/observability/server/routes/types.ts", + "lineNumber": 39 + }, + "signature": [ + "ServerRouteRepository>>" + ], + "initialIsOpen": false + }, { "id": "def-server.Mappings", "type": "Type", @@ -2635,6 +3148,23 @@ ], "initialIsOpen": false }, + { + "id": "def-server.ObservabilityAPIReturnType", + "type": "Type", + "label": "ObservabilityAPIReturnType", + "tags": [], + "description": [], + "source": { + "path": "x-pack/plugins/observability/server/routes/types.ts", + "lineNumber": 54 + }, + "signature": [ + "TEndpoint extends \"GET /api/observability/rules/alerts/top\" | \"GET /api/observability/rules/alerts/dynamic_index_pattern\" ? ({ \"GET /api/observability/rules/alerts/top\": ServerRoute<\"GET /api/observability/rules/alerts/top\", t.TypeC<{ query: t.IntersectionC<[t.TypeC<{ start: t.Type; end: t.Type; }>, t.PartialC<{ kuery: t.StringC; size: t.Type; }>]>; }>, ObservabilityRouteHandlerResources, any, ObservabilityRouteCreateOptions>; } & { \"GET /api/observability/rules/alerts/dynamic_index_pattern\": ServerRoute<\"GET /api/observability/rules/alerts/dynamic_index_pattern\", undefined, ObservabilityRouteHandlerResources, { title: string; timeFieldName: string; fields: ", + "IndexPatternFieldDescriptor", + "[]; }, ObservabilityRouteCreateOptions>; })[TEndpoint] extends ServerRoute> ? TReturnType : never : never" + ], + "initialIsOpen": false + }, { "id": "def-server.ObservabilityConfig", "type": "Type", @@ -2643,10 +3173,60 @@ "description": [], "source": { "path": "x-pack/plugins/observability/server/index.ts", - "lineNumber": 25 + "lineNumber": 34 + }, + "signature": [ + "{ readonly enabled: boolean; readonly annotations: Readonly<{} & { enabled: boolean; index: string; }>; readonly unsafe: Readonly<{} & { alertingExperience: Readonly<{} & { enabled: boolean; }>; }>; }" + ], + "initialIsOpen": false + }, + { + "id": "def-server.ObservabilityRuleRegistryClient", + "type": "Type", + "label": "ObservabilityRuleRegistryClient", + "tags": [], + "description": [], + "source": { + "path": "x-pack/plugins/observability/server/types.ts", + "lineNumber": 35 }, "signature": [ - "{ readonly enabled: boolean; readonly annotations: Readonly<{} & { enabled: boolean; index: string; }>; }" + "ScopedRuleRegistryClient<{ 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; }; }>" + ], + "initialIsOpen": false + }, + { + "id": "def-server.ObservabilityServerRouteRepository", + "type": "Type", + "label": "ObservabilityServerRouteRepository", + "tags": [], + "description": [], + "source": { + "path": "x-pack/plugins/observability/server/routes/get_global_observability_server_route_repository.ts", + "lineNumber": 13 + }, + "signature": [ + "ServerRouteRepository", + "<", + { + "pluginId": "observability", + "scope": "server", + "docId": "kibObservabilityPluginApi", + "section": "def-server.ObservabilityRouteHandlerResources", + "text": "ObservabilityRouteHandlerResources" + }, + ", ", + { + "pluginId": "observability", + "scope": "server", + "docId": "kibObservabilityPluginApi", + "section": "def-server.ObservabilityRouteCreateOptions", + "text": "ObservabilityRouteCreateOptions" + }, + ", { \"GET /api/observability/rules/alerts/top\": ", + "ServerRoute", + "<\"GET /api/observability/rules/alerts/top\", ", + "TypeC" ], "initialIsOpen": false }, @@ -2658,7 +3238,7 @@ "description": [], "source": { "path": "x-pack/plugins/observability/server/lib/annotations/bootstrap_annotations.ts", - "lineNumber": 24 + "lineNumber": 29 }, "signature": [ "{ readonly index: string; create: (createParams: { annotation: { type: string; }; '@timestamp': string; message: string; } & { tags?: string[] | undefined; service?: { name?: string | undefined; environment?: string | undefined; version?: string | undefined; } | undefined; }) => Promise<{ _id: string; _index: string; _source: ", @@ -2681,12 +3261,26 @@ "description": [], "source": { "path": "x-pack/plugins/observability/server/plugin.ts", - "lineNumber": 20 + "lineNumber": 22 }, "signature": [ "{ getScopedAnnotationsClient: (requestContext: ", - "ObservabilityRequestHandlerContext", - ", request: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.RequestHandlerContext", + "text": "RequestHandlerContext" + }, + " & { licensing: ", + { + "pluginId": "licensing", + "scope": "server", + "docId": "kibLicensingPluginApi", + "section": "def-server.LicensingApiRequestHandlerContext", + "text": "LicensingApiRequestHandlerContext" + }, + "; }, request: ", { "pluginId": "core", "scope": "server", @@ -2697,9 +3291,7 @@ ") => Promise<{ readonly index: string; create: (createParams: { annotation: { type: string; }; '@timestamp': string; message: string; } & { tags?: string[] | undefined; service?: { name?: string | undefined; environment?: string | undefined; version?: string | undefined; } | undefined; }) => Promise<{ _id: string; _index: string; _source: ", "Annotation", "; }>; getById: (getByIdParams: { id: string; }) => Promise<", - "GetResponse", - ">; delete: (deleteParams: { id: string; }) => Promise<", - "DeleteResponse" + "GetResponse" ], "lifecycle": "setup", "initialIsOpen": true diff --git a/api_docs/observability.mdx b/api_docs/observability.mdx index ef0e952f5161c..59a9b7f550477 100644 --- a/api_docs/observability.mdx +++ b/api_docs/observability.mdx @@ -22,6 +22,9 @@ import observabilityObj from './observability.json'; ### Functions +### Classes + + ### Interfaces @@ -42,6 +45,9 @@ import observabilityObj from './observability.json'; ### Classes +### Interfaces + + ### Consts, variables and types diff --git a/api_docs/osquery.json b/api_docs/osquery.json index 338bb00726253..10980e0bc795f 100644 --- a/api_docs/osquery.json +++ b/api_docs/osquery.json @@ -16,7 +16,7 @@ "children": [], "source": { "path": "x-pack/plugins/osquery/public/types.ts", - "lineNumber": 18 + "lineNumber": 20 }, "lifecycle": "setup", "initialIsOpen": true @@ -30,7 +30,7 @@ "children": [], "source": { "path": "x-pack/plugins/osquery/public/types.ts", - "lineNumber": 20 + "lineNumber": 22 }, "lifecycle": "start", "initialIsOpen": true @@ -52,7 +52,7 @@ "children": [], "source": { "path": "x-pack/plugins/osquery/server/types.ts", - "lineNumber": 16 + "lineNumber": 17 }, "lifecycle": "setup", "initialIsOpen": true @@ -66,7 +66,7 @@ "children": [], "source": { "path": "x-pack/plugins/osquery/server/types.ts", - "lineNumber": 18 + "lineNumber": 19 }, "lifecycle": "start", "initialIsOpen": true @@ -78,6 +78,21 @@ "interfaces": [], "enums": [], "misc": [ + { + "tags": [], + "id": "def-common.BASE_PATH", + "type": "string", + "label": "BASE_PATH", + "description": [], + "source": { + "path": "x-pack/plugins/osquery/common/constants.ts", + "lineNumber": 11 + }, + "signature": [ + "\"/app/osquery\"" + ], + "initialIsOpen": false + }, { "tags": [], "id": "def-common.DEFAULT_DARK_MODE", @@ -108,6 +123,21 @@ ], "initialIsOpen": false }, + { + "tags": [], + "id": "def-common.OSQUERY_INTEGRATION_NAME", + "type": "string", + "label": "OSQUERY_INTEGRATION_NAME", + "description": [], + "source": { + "path": "x-pack/plugins/osquery/common/constants.ts", + "lineNumber": 10 + }, + "signature": [ + "\"osquery_manager\"" + ], + "initialIsOpen": false + }, { "tags": [], "id": "def-common.PLUGIN_ID", diff --git a/api_docs/presentation_util.json b/api_docs/presentation_util.json index 351fd76adf704..9c379476ef392 100644 --- a/api_docs/presentation_util.json +++ b/api_docs/presentation_util.json @@ -3,6 +3,42 @@ "client": { "classes": [], "functions": [ + { + "id": "def-public.AddFromLibraryButton", + "type": "Function", + "children": [ + { + "id": "def-public.AddFromLibraryButton.$1", + "type": "Object", + "label": "{ onClick, ...rest }", + "isRequired": true, + "signature": [ + "Pick<", + "Props", + ", \"onClick\" | \"className\" | \"primary\" | \"iconSide\" | \"isDarkModeEnabled\">" + ], + "description": [], + "source": { + "path": "src/plugins/presentation_util/public/components/solution_toolbar/items/add_from_library.tsx", + "lineNumber": 17 + } + } + ], + "signature": [ + "({ onClick, ...rest }: Pick<", + "Props", + ", \"onClick\" | \"className\" | \"primary\" | \"iconSide\" | \"isDarkModeEnabled\">) => JSX.Element" + ], + "description": [], + "label": "AddFromLibraryButton", + "source": { + "path": "src/plugins/presentation_util/public/components/solution_toolbar/items/add_from_library.tsx", + "lineNumber": 17 + }, + "tags": [], + "returnComment": [], + "initialIsOpen": false + }, { "tags": [], "id": "def-public.LazyDashboardPicker", @@ -11,116 +47,618 @@ "description": [], "source": { "path": "src/plugins/presentation_util/public/components/index.tsx", - "lineNumber": 34 + "lineNumber": 32 }, "signature": [ "React.LazyExoticComponent" ], - "initialIsOpen": false - }, - { - "tags": [], - "id": "def-public.LazyLabsBeakerButton", - "type": "Function", - "label": "LazyLabsBeakerButton", - "description": [], + "initialIsOpen": false + }, + { + "tags": [], + "id": "def-public.LazyLabsBeakerButton", + "type": "Function", + "label": "LazyLabsBeakerButton", + "description": [], + "source": { + "path": "src/plugins/presentation_util/public/components/index.tsx", + "lineNumber": 28 + }, + "signature": [ + "React.LazyExoticComponent<({ solutions, ...props }: ", + "Props", + ") => JSX.Element>" + ], + "initialIsOpen": false + }, + { + "tags": [], + "id": "def-public.LazyLabsFlyout", + "type": "Function", + "label": "LazyLabsFlyout", + "description": [], + "source": { + "path": "src/plugins/presentation_util/public/components/index.tsx", + "lineNumber": 30 + }, + "signature": [ + "React.LazyExoticComponent<(props: ", + "Props", + ") => JSX.Element>" + ], + "initialIsOpen": false + }, + { + "tags": [], + "id": "def-public.LazySavedObjectSaveModalDashboard", + "type": "Function", + "label": "LazySavedObjectSaveModalDashboard", + "description": [], + "source": { + "path": "src/plugins/presentation_util/public/components/index.tsx", + "lineNumber": 34 + }, + "signature": [ + "React.LazyExoticComponent" + ], + "initialIsOpen": false + }, + { + "id": "def-public.PrimaryActionButton", + "type": "Function", + "children": [ + { + "id": "def-public.PrimaryActionButton.$1", + "type": "Object", + "label": "{ isDarkModeEnabled, ...props }", + "isRequired": true, + "signature": [ + "Props" + ], + "description": [], + "source": { + "path": "src/plugins/presentation_util/public/components/solution_toolbar/items/primary_button.tsx", + "lineNumber": 19 + } + } + ], + "signature": [ + "({ isDarkModeEnabled, ...props }: ", + "Props", + ") => JSX.Element" + ], + "description": [], + "label": "PrimaryActionButton", + "source": { + "path": "src/plugins/presentation_util/public/components/solution_toolbar/items/primary_button.tsx", + "lineNumber": 19 + }, + "tags": [], + "returnComment": [], + "initialIsOpen": false + }, + { + "id": "def-public.PrimaryActionPopover", + "type": "Function", + "children": [ + { + "id": "def-public.PrimaryActionPopover.$1", + "type": "Object", + "label": "props", + "isRequired": true, + "signature": [ + "Pick<", + "Props", + ", \"children\" | \"onClick\" | \"onChange\" | \"color\" | \"label\" | \"onKeyDown\" | \"title\" | \"id\" | \"placeholder\" | \"iconType\" | \"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\" | \"panelRef\" | \"data-test-subj\" | \"display\" | \"offset\" | \"iconSide\" | \"buttonRef\" | \"hasArrow\" | \"isDarkModeEnabled\" | \"anchorClassName\" | \"attachToAnchor\" | \"container\" | \"focusTrapProps\" | \"initialFocus\" | \"insert\" | \"ownFocus\" | \"panelClassName\" | \"panelPaddingSize\" | \"panelStyle\" | \"panelProps\" | \"popoverRef\" | \"repositionOnScroll\" | \"zIndex\" | \"onTrapDeactivation\" | \"buffer\" | \"arrowChildren\">" + ], + "description": [], + "source": { + "path": "src/plugins/presentation_util/public/components/solution_toolbar/items/primary_popover.tsx", + "lineNumber": 15 + } + } + ], + "signature": [ + "(props: Pick<", + "Props", + ", \"children\" | \"onClick\" | \"onChange\" | \"color\" | \"label\" | \"onKeyDown\" | \"title\" | \"id\" | \"placeholder\" | \"iconType\" | \"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\" | \"panelRef\" | \"data-test-subj\" | \"display\" | \"offset\" | \"iconSide\" | \"buttonRef\" | \"hasArrow\" | \"isDarkModeEnabled\" | \"anchorClassName\" | \"attachToAnchor\" | \"container\" | \"focusTrapProps\" | \"initialFocus\" | \"insert\" | \"ownFocus\" | \"panelClassName\" | \"panelPaddingSize\" | \"panelStyle\" | \"panelProps\" | \"popoverRef\" | \"repositionOnScroll\" | \"zIndex\" | \"onTrapDeactivation\" | \"buffer\" | \"arrowChildren\">) => JSX.Element" + ], + "description": [], + "label": "PrimaryActionPopover", + "source": { + "path": "src/plugins/presentation_util/public/components/solution_toolbar/items/primary_popover.tsx", + "lineNumber": 15 + }, + "tags": [], + "returnComment": [], + "initialIsOpen": false + }, + { + "id": "def-public.QuickButtonGroup", + "type": "Function", + "children": [ + { + "id": "def-public.QuickButtonGroup.$1", + "type": "Object", + "label": "{ buttons }", + "isRequired": true, + "signature": [ + "Props" + ], + "description": [], + "source": { + "path": "src/plugins/presentation_util/public/components/solution_toolbar/items/quick_group.tsx", + "lineNumber": 30 + } + } + ], + "signature": [ + "({ buttons }: ", + "Props", + ") => JSX.Element" + ], + "description": [], + "label": "QuickButtonGroup", + "source": { + "path": "src/plugins/presentation_util/public/components/solution_toolbar/items/quick_group.tsx", + "lineNumber": 30 + }, + "tags": [], + "returnComment": [], + "initialIsOpen": false + }, + { + "id": "def-public.SolutionToolbar", + "type": "Function", + "children": [ + { + "id": "def-public.SolutionToolbar.$1", + "type": "Object", + "label": "{ isDarkModeEnabled, children }", + "isRequired": true, + "signature": [ + "Props" + ], + "description": [], + "source": { + "path": "src/plugins/presentation_util/public/components/solution_toolbar/solution_toolbar.tsx", + "lineNumber": 35 + } + } + ], + "signature": [ + "({ isDarkModeEnabled, children }: ", + "Props", + ") => JSX.Element" + ], + "description": [], + "label": "SolutionToolbar", + "source": { + "path": "src/plugins/presentation_util/public/components/solution_toolbar/solution_toolbar.tsx", + "lineNumber": 35 + }, + "tags": [], + "returnComment": [], + "initialIsOpen": false + }, + { + "id": "def-public.SolutionToolbarButton", + "type": "Function", + "children": [ + { + "id": "def-public.SolutionToolbarButton.$1", + "type": "Object", + "label": "{ label, primary, className, ...rest }", + "isRequired": true, + "signature": [ + "Props" + ], + "description": [], + "source": { + "path": "src/plugins/presentation_util/public/components/solution_toolbar/items/button.tsx", + "lineNumber": 22 + } + } + ], + "signature": [ + "({ label, primary, className, ...rest }: ", + "Props", + ") => JSX.Element" + ], + "description": [], + "label": "SolutionToolbarButton", + "source": { + "path": "src/plugins/presentation_util/public/components/solution_toolbar/items/button.tsx", + "lineNumber": 22 + }, + "tags": [], + "returnComment": [], + "initialIsOpen": false + }, + { + "id": "def-public.SolutionToolbarPopover", + "type": "Function", + "children": [ + { + "id": "def-public.SolutionToolbarPopover.$1", + "type": "CompoundType", + "label": "{\n label,\n iconType,\n primary,\n iconSide,\n ...popover\n}", + "isRequired": true, + "signature": [ + "Props" + ], + "description": [], + "source": { + "path": "src/plugins/presentation_util/public/components/solution_toolbar/items/popover.tsx", + "lineNumber": 23 + } + } + ], + "signature": [ + "({ label, iconType, primary, iconSide, ...popover }: ", + "Props", + ") => JSX.Element" + ], + "description": [], + "label": "SolutionToolbarPopover", + "source": { + "path": "src/plugins/presentation_util/public/components/solution_toolbar/items/popover.tsx", + "lineNumber": 23 + }, + "tags": [], + "returnComment": [], + "initialIsOpen": false + }, + { + "id": "def-public.withSuspense", + "type": "Function", + "children": [ + { + "id": "def-public.withSuspense.$1", + "type": "CompoundType", + "label": "Component", + "isRequired": true, + "signature": [ + "React.ComponentType

" + ], + "description": [], + "source": { + "path": "src/plugins/presentation_util/public/components/index.tsx", + "lineNumber": 18 + } + }, + { + "id": "def-public.withSuspense.$2", + "type": "CompoundType", + "label": "fallback", + "isRequired": false, + "signature": [ + "React.ReactElement React.ReactElement React.Component)> | null) | (new (props: any) => React.Component)> | null" + ], + "description": [], + "source": { + "path": "src/plugins/presentation_util/public/components/index.tsx", + "lineNumber": 19 + } + } + ], + "signature": [ + "

(Component: React.ComponentType

, fallback?: React.ReactElement React.ReactElement React.Component)> | null) | (new (props: any) => React.Component)> | null) => (props: P) => JSX.Element" + ], + "description": [ + "\nA HOC which supplies React.Suspense with a fallback component, and a `EuiErrorBoundary` to contain errors." + ], + "label": "withSuspense", + "source": { + "path": "src/plugins/presentation_util/public/components/index.tsx", + "lineNumber": 17 + }, + "tags": [], + "returnComment": [], + "initialIsOpen": false + } + ], + "interfaces": [ + { + "id": "def-public.PresentationCapabilitiesService", + "type": "Interface", + "label": "PresentationCapabilitiesService", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-public.PresentationCapabilitiesService.canAccessDashboards", + "type": "Function", + "label": "canAccessDashboards", + "description": [], + "source": { + "path": "src/plugins/presentation_util/public/services/capabilities.ts", + "lineNumber": 10 + }, + "signature": [ + "() => boolean" + ] + }, + { + "tags": [], + "id": "def-public.PresentationCapabilitiesService.canCreateNewDashboards", + "type": "Function", + "label": "canCreateNewDashboards", + "description": [], + "source": { + "path": "src/plugins/presentation_util/public/services/capabilities.ts", + "lineNumber": 11 + }, + "signature": [ + "() => boolean" + ] + }, + { + "tags": [], + "id": "def-public.PresentationCapabilitiesService.canSaveVisualizations", + "type": "Function", + "label": "canSaveVisualizations", + "description": [], + "source": { + "path": "src/plugins/presentation_util/public/services/capabilities.ts", + "lineNumber": 12 + }, + "signature": [ + "() => boolean" + ] + }, + { + "tags": [], + "id": "def-public.PresentationCapabilitiesService.canSetAdvancedSettings", + "type": "Function", + "label": "canSetAdvancedSettings", + "description": [], + "source": { + "path": "src/plugins/presentation_util/public/services/capabilities.ts", + "lineNumber": 13 + }, + "signature": [ + "() => boolean" + ] + } + ], + "source": { + "path": "src/plugins/presentation_util/public/services/capabilities.ts", + "lineNumber": 9 + }, + "initialIsOpen": false + }, + { + "id": "def-public.PresentationDashboardsService", + "type": "Interface", + "label": "PresentationDashboardsService", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-public.PresentationDashboardsService.findDashboards", + "type": "Function", + "label": "findDashboards", + "description": [], + "source": { + "path": "src/plugins/presentation_util/public/services/dashboards.ts", + "lineNumber": 13 + }, + "signature": [ + "(query: string, fields: string[]) => Promise<", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-public.SimpleSavedObject", + "text": "SimpleSavedObject" + }, + "<", + "PartialDashboardAttributes", + ">[]>" + ] + }, + { + "tags": [], + "id": "def-public.PresentationDashboardsService.findDashboardsByTitle", + "type": "Function", + "label": "findDashboardsByTitle", + "description": [], + "source": { + "path": "src/plugins/presentation_util/public/services/dashboards.ts", + "lineNumber": 17 + }, + "signature": [ + "(title: string) => Promise<", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-public.SimpleSavedObject", + "text": "SimpleSavedObject" + }, + "<", + "PartialDashboardAttributes", + ">[]>" + ] + } + ], + "source": { + "path": "src/plugins/presentation_util/public/services/dashboards.ts", + "lineNumber": 12 + }, + "initialIsOpen": false + }, + { + "id": "def-public.PresentationLabsService", + "type": "Interface", + "label": "PresentationLabsService", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-public.PresentationLabsService.getProjectIDs", + "type": "Function", + "label": "getProjectIDs", + "description": [], + "source": { + "path": "src/plugins/presentation_util/public/services/labs.ts", + "lineNumber": 23 + }, + "signature": [ + "() => readonly [\"labs:presentation:timeToPresent\", \"labs:canvas:useDataService\"]" + ] + }, + { + "tags": [], + "id": "def-public.PresentationLabsService.getProject", + "type": "Function", + "label": "getProject", + "description": [], + "source": { + "path": "src/plugins/presentation_util/public/services/labs.ts", + "lineNumber": 24 + }, + "signature": [ + "(id: \"labs:presentation:timeToPresent\" | \"labs:canvas:useDataService\") => ", + { + "pluginId": "presentationUtil", + "scope": "common", + "docId": "kibPresentationUtilPluginApi", + "section": "def-common.Project", + "text": "Project" + } + ] + }, + { + "tags": [], + "id": "def-public.PresentationLabsService.getProjects", + "type": "Function", + "label": "getProjects", + "description": [], + "source": { + "path": "src/plugins/presentation_util/public/services/labs.ts", + "lineNumber": 25 + }, + "signature": [ + "(solutions?: (\"dashboard\" | \"canvas\" | \"presentation\")[] | undefined) => Record<\"labs:presentation:timeToPresent\" | \"labs:canvas:useDataService\", ", + { + "pluginId": "presentationUtil", + "scope": "common", + "docId": "kibPresentationUtilPluginApi", + "section": "def-common.Project", + "text": "Project" + }, + ">" + ] + }, + { + "tags": [], + "id": "def-public.PresentationLabsService.setProjectStatus", + "type": "Function", + "label": "setProjectStatus", + "description": [], + "source": { + "path": "src/plugins/presentation_util/public/services/labs.ts", + "lineNumber": 26 + }, + "signature": [ + "(id: \"labs:presentation:timeToPresent\" | \"labs:canvas:useDataService\", env: \"kibana\" | \"browser\" | \"session\", status: boolean) => void" + ] + }, + { + "tags": [], + "id": "def-public.PresentationLabsService.reset", + "type": "Function", + "label": "reset", + "description": [], + "source": { + "path": "src/plugins/presentation_util/public/services/labs.ts", + "lineNumber": 27 + }, + "signature": [ + "() => void" + ] + } + ], "source": { - "path": "src/plugins/presentation_util/public/components/index.tsx", - "lineNumber": 28 + "path": "src/plugins/presentation_util/public/services/labs.ts", + "lineNumber": 22 }, - "signature": [ - "(props: ", - "Props", - ") => JSX.Element" - ], "initialIsOpen": false }, { - "tags": [], - "id": "def-public.LazyLabsFlyout", - "type": "Function", - "label": "LazyLabsFlyout", - "description": [], - "source": { - "path": "src/plugins/presentation_util/public/components/index.tsx", - "lineNumber": 32 - }, + "id": "def-public.QuickButtonProps", + "type": "Interface", + "label": "QuickButtonProps", "signature": [ - "(props: ", - "Props", - ") => JSX.Element" + { + "pluginId": "presentationUtil", + "scope": "public", + "docId": "kibPresentationUtilPluginApi", + "section": "def-public.QuickButtonProps", + "text": "QuickButtonProps" + }, + " extends Pick<", + "EuiButtonGroupOptionProps", + ", \"iconType\">" ], - "initialIsOpen": false - }, - { - "tags": [], - "id": "def-public.LazySavedObjectSaveModalDashboard", - "type": "Function", - "label": "LazySavedObjectSaveModalDashboard", "description": [], - "source": { - "path": "src/plugins/presentation_util/public/components/index.tsx", - "lineNumber": 36 - }, - "signature": [ - "React.LazyExoticComponent" - ], - "initialIsOpen": false - }, - { - "id": "def-public.withSuspense", - "type": "Function", + "tags": [], "children": [ { - "id": "def-public.withSuspense.$1", - "type": "CompoundType", - "label": "Component", - "isRequired": true, - "signature": [ - "React.ComponentType

" - ], + "tags": [], + "id": "def-public.QuickButtonProps.createType", + "type": "string", + "label": "createType", "description": [], "source": { - "path": "src/plugins/presentation_util/public/components/index.tsx", + "path": "src/plugins/presentation_util/public/components/solution_toolbar/items/quick_group.tsx", "lineNumber": 18 } }, { - "id": "def-public.withSuspense.$2", - "type": "CompoundType", - "label": "fallback", - "isRequired": false, - "signature": [ - "React.ReactElement React.ReactElement React.Component)> | null) | (new (props: any) => React.Component)> | null" - ], + "tags": [], + "id": "def-public.QuickButtonProps.onClick", + "type": "Function", + "label": "onClick", "description": [], "source": { - "path": "src/plugins/presentation_util/public/components/index.tsx", + "path": "src/plugins/presentation_util/public/components/solution_toolbar/items/quick_group.tsx", "lineNumber": 19 - } + }, + "signature": [ + "() => void" + ] + }, + { + "tags": [], + "id": "def-public.QuickButtonProps.isDarkModeEnabled", + "type": "CompoundType", + "label": "isDarkModeEnabled", + "description": [], + "source": { + "path": "src/plugins/presentation_util/public/components/solution_toolbar/items/quick_group.tsx", + "lineNumber": 20 + }, + "signature": [ + "boolean | undefined" + ] } ], - "signature": [ - "

(Component: React.ComponentType

, fallback?: React.ReactElement React.ReactElement React.Component)> | null) | (new (props: any) => React.Component)> | null) => (props: P) => JSX.Element" - ], - "description": [ - "\nA HOC which supplies React.Suspense with a fallback component, and a `EuiErrorBoundary` to contain errors." - ], - "label": "withSuspense", "source": { - "path": "src/plugins/presentation_util/public/components/index.tsx", + "path": "src/plugins/presentation_util/public/components/solution_toolbar/items/quick_group.tsx", "lineNumber": 17 }, - "tags": [], - "returnComment": [], "initialIsOpen": false - } - ], - "interfaces": [ + }, { "id": "def-public.SaveModalDashboardProps", "type": "Interface", @@ -240,7 +778,7 @@ "description": [], "source": { "path": "src/plugins/presentation_util/common/labs.ts", - "lineNumber": 59 + "lineNumber": 78 }, "signature": [ "ProjectConfig & { status: ProjectStatus; }" @@ -255,10 +793,10 @@ "description": [], "source": { "path": "src/plugins/presentation_util/common/labs.ts", - "lineNumber": 36 + "lineNumber": 54 }, "signature": [ - "\"labs:presentation:unifiedToolbar\"" + "\"labs:presentation:timeToPresent\" | \"labs:canvas:useDataService\"" ], "initialIsOpen": false } @@ -272,10 +810,10 @@ "description": [], "source": { "path": "src/plugins/presentation_util/common/labs.ts", - "lineNumber": 13 + "lineNumber": 14 }, "signature": [ - "readonly [\"labs:presentation:unifiedToolbar\"]" + "readonly [\"labs:presentation:timeToPresent\", \"labs:canvas:useDataService\"]" ], "initialIsOpen": false } @@ -326,7 +864,13 @@ "lineNumber": 16 }, "signature": [ - "PresentationLabsService" + { + "pluginId": "presentationUtil", + "scope": "public", + "docId": "kibPresentationUtilPluginApi", + "section": "def-public.PresentationLabsService", + "text": "PresentationLabsService" + } ] } ], @@ -343,7 +887,23 @@ "functions": [], "interfaces": [], "enums": [], - "misc": [], + "misc": [ + { + "tags": [], + "id": "def-server.SETTING_CATEGORY", + "type": "string", + "label": "SETTING_CATEGORY", + "description": [], + "source": { + "path": "src/plugins/presentation_util/server/ui_settings.ts", + "lineNumber": 13 + }, + "signature": [ + "\"Presentation Labs\"" + ], + "initialIsOpen": false + } + ], "objects": [] }, "common": { @@ -354,13 +914,13 @@ "type": "Function", "children": [], "signature": [ - "() => readonly [\"labs:presentation:unifiedToolbar\"]" + "() => readonly [\"labs:presentation:timeToPresent\", \"labs:canvas:useDataService\"]" ], "description": [], "label": "getProjectIDs", "source": { "path": "src/plugins/presentation_util/common/labs.ts", - "lineNumber": 61 + "lineNumber": 80 }, "tags": [], "returnComment": [], @@ -381,7 +941,7 @@ "description": [], "source": { "path": "src/plugins/presentation_util/common/labs.ts", - "lineNumber": 63 + "lineNumber": 82 } }, { @@ -401,7 +961,7 @@ "description": [], "source": { "path": "src/plugins/presentation_util/common/labs.ts", - "lineNumber": 63 + "lineNumber": 82 } } ], @@ -420,7 +980,7 @@ "label": "isProjectEnabledByStatus", "source": { "path": "src/plugins/presentation_util/common/labs.ts", - "lineNumber": 63 + "lineNumber": 82 }, "tags": [], "returnComment": [], @@ -438,15 +998,15 @@ { "tags": [], "id": "def-common.ProjectConfig.id", - "type": "string", + "type": "CompoundType", "label": "id", "description": [], "source": { "path": "src/plugins/presentation_util/common/labs.ts", - "lineNumber": 51 + "lineNumber": 69 }, "signature": [ - "\"labs:presentation:unifiedToolbar\"" + "\"labs:presentation:timeToPresent\" | \"labs:canvas:useDataService\"" ] }, { @@ -457,7 +1017,7 @@ "description": [], "source": { "path": "src/plugins/presentation_util/common/labs.ts", - "lineNumber": 52 + "lineNumber": 70 } }, { @@ -468,7 +1028,18 @@ "description": [], "source": { "path": "src/plugins/presentation_util/common/labs.ts", - "lineNumber": 53 + "lineNumber": 71 + } + }, + { + "tags": [], + "id": "def-common.ProjectConfig.isDisplayed", + "type": "boolean", + "label": "isDisplayed", + "description": [], + "source": { + "path": "src/plugins/presentation_util/common/labs.ts", + "lineNumber": 72 } }, { @@ -479,7 +1050,7 @@ "description": [], "source": { "path": "src/plugins/presentation_util/common/labs.ts", - "lineNumber": 54 + "lineNumber": 73 }, "signature": [ "(\"kibana\" | \"browser\" | \"session\")[]" @@ -493,7 +1064,7 @@ "description": [], "source": { "path": "src/plugins/presentation_util/common/labs.ts", - "lineNumber": 55 + "lineNumber": 74 } }, { @@ -504,7 +1075,7 @@ "description": [], "source": { "path": "src/plugins/presentation_util/common/labs.ts", - "lineNumber": 56 + "lineNumber": 75 }, "signature": [ "(\"dashboard\" | \"canvas\" | \"presentation\")[]" @@ -513,7 +1084,7 @@ ], "source": { "path": "src/plugins/presentation_util/common/labs.ts", - "lineNumber": 50 + "lineNumber": 68 }, "initialIsOpen": false } @@ -528,7 +1099,7 @@ "description": [], "source": { "path": "src/plugins/presentation_util/common/labs.ts", - "lineNumber": 37 + "lineNumber": 55 }, "signature": [ "\"kibana\" | \"browser\" | \"session\"" @@ -543,7 +1114,7 @@ "description": [], "source": { "path": "src/plugins/presentation_util/common/labs.ts", - "lineNumber": 40 + "lineNumber": 58 }, "signature": [ "{ kibana?: boolean | undefined; browser?: boolean | undefined; session?: boolean | undefined; }" @@ -588,7 +1159,7 @@ "description": [], "source": { "path": "src/plugins/presentation_util/common/labs.ts", - "lineNumber": 59 + "lineNumber": 78 }, "signature": [ "ProjectConfig & { status: ProjectStatus; }" @@ -603,10 +1174,10 @@ "description": [], "source": { "path": "src/plugins/presentation_util/common/labs.ts", - "lineNumber": 36 + "lineNumber": 54 }, "signature": [ - "\"labs:presentation:unifiedToolbar\"" + "\"labs:presentation:timeToPresent\" | \"labs:canvas:useDataService\"" ], "initialIsOpen": false }, @@ -618,7 +1189,7 @@ "description": [], "source": { "path": "src/plugins/presentation_util/common/labs.ts", - "lineNumber": 44 + "lineNumber": 62 }, "signature": [ "{ defaultValue: boolean; isEnabled: boolean; isOverride: boolean; } & EnvironmentStatus" @@ -633,7 +1204,7 @@ "description": [], "source": { "path": "src/plugins/presentation_util/common/labs.ts", - "lineNumber": 38 + "lineNumber": 56 }, "signature": [ "\"dashboard\" | \"canvas\" | \"presentation\"" @@ -642,16 +1213,31 @@ }, { "tags": [], - "id": "def-common.UNIFIED_TOOLBAR", + "id": "def-common.TIME_TO_PRESENT", + "type": "string", + "label": "TIME_TO_PRESENT", + "description": [], + "source": { + "path": "src/plugins/presentation_util/common/labs.ts", + "lineNumber": 12 + }, + "signature": [ + "\"labs:presentation:timeToPresent\"" + ], + "initialIsOpen": false + }, + { + "tags": [], + "id": "def-common.USE_DATA_SERVICE", "type": "string", - "label": "UNIFIED_TOOLBAR", + "label": "USE_DATA_SERVICE", "description": [], "source": { "path": "src/plugins/presentation_util/common/labs.ts", "lineNumber": 11 }, "signature": [ - "\"labs:presentation:unifiedToolbar\"" + "\"labs:canvas:useDataService\"" ], "initialIsOpen": false } @@ -665,7 +1251,7 @@ "description": [], "source": { "path": "src/plugins/presentation_util/common/labs.ts", - "lineNumber": 14 + "lineNumber": 15 }, "signature": [ "readonly [\"kibana\", \"browser\", \"session\"]" @@ -680,10 +1266,10 @@ "description": [], "source": { "path": "src/plugins/presentation_util/common/labs.ts", - "lineNumber": 13 + "lineNumber": 14 }, "signature": [ - "readonly [\"labs:presentation:unifiedToolbar\"]" + "readonly [\"labs:presentation:timeToPresent\", \"labs:canvas:useDataService\"]" ], "initialIsOpen": false }, @@ -693,33 +1279,47 @@ "tags": [], "children": [ { - "id": "def-common.projects.UNIFIED_TOOLBAR", + "id": "def-common.projects.TIME_TO_PRESENT", "type": "Object", "tags": [], "children": [ { "tags": [], - "id": "def-common.projects.UNIFIED_TOOLBAR.id", + "id": "def-common.projects.TIME_TO_PRESENT.id", "type": "string", "label": "id", "description": [], "source": { "path": "src/plugins/presentation_util/common/labs.ts", - "lineNumber": 23 + "lineNumber": 24 }, "signature": [ - "\"labs:presentation:unifiedToolbar\"" + "\"labs:presentation:timeToPresent\"" ] }, { "tags": [], - "id": "def-common.projects.UNIFIED_TOOLBAR.isActive", + "id": "def-common.projects.TIME_TO_PRESENT.isActive", "type": "boolean", "label": "isActive", "description": [], "source": { "path": "src/plugins/presentation_util/common/labs.ts", - "lineNumber": 24 + "lineNumber": 25 + }, + "signature": [ + "false" + ] + }, + { + "tags": [], + "id": "def-common.projects.TIME_TO_PRESENT.isDisplayed", + "type": "boolean", + "label": "isDisplayed", + "description": [], + "source": { + "path": "src/plugins/presentation_util/common/labs.ts", + "lineNumber": 26 }, "signature": [ "false" @@ -727,13 +1327,13 @@ }, { "tags": [], - "id": "def-common.projects.UNIFIED_TOOLBAR.environments", + "id": "def-common.projects.TIME_TO_PRESENT.environments", "type": "Array", "label": "environments", "description": [], "source": { "path": "src/plugins/presentation_util/common/labs.ts", - "lineNumber": 25 + "lineNumber": 27 }, "signature": [ "(\"kibana\" | \"browser\" | \"session\")[]" @@ -741,46 +1341,151 @@ }, { "tags": [], - "id": "def-common.projects.UNIFIED_TOOLBAR.name", + "id": "def-common.projects.TIME_TO_PRESENT.name", "type": "string", "label": "name", "description": [], "source": { "path": "src/plugins/presentation_util/common/labs.ts", - "lineNumber": 26 + "lineNumber": 28 } }, { "tags": [], - "id": "def-common.projects.UNIFIED_TOOLBAR.description", + "id": "def-common.projects.TIME_TO_PRESENT.description", "type": "string", "label": "description", "description": [], "source": { "path": "src/plugins/presentation_util/common/labs.ts", - "lineNumber": 29 + "lineNumber": 31 } }, { "tags": [], - "id": "def-common.projects.UNIFIED_TOOLBAR.solutions", + "id": "def-common.projects.TIME_TO_PRESENT.solutions", "type": "Array", "label": "solutions", "description": [], "source": { "path": "src/plugins/presentation_util/common/labs.ts", - "lineNumber": 32 + "lineNumber": 34 }, "signature": [ - "(\"dashboard\" | \"canvas\")[]" + "\"canvas\"[]" ] } ], "description": [], - "label": "[UNIFIED_TOOLBAR]", + "label": "[TIME_TO_PRESENT]", "source": { "path": "src/plugins/presentation_util/common/labs.ts", - "lineNumber": 22 + "lineNumber": 23 + } + }, + { + "id": "def-common.projects.USE_DATA_SERVICE", + "type": "Object", + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.projects.USE_DATA_SERVICE.id", + "type": "string", + "label": "id", + "description": [], + "source": { + "path": "src/plugins/presentation_util/common/labs.ts", + "lineNumber": 37 + }, + "signature": [ + "\"labs:canvas:useDataService\"" + ] + }, + { + "tags": [], + "id": "def-common.projects.USE_DATA_SERVICE.isActive", + "type": "boolean", + "label": "isActive", + "description": [], + "source": { + "path": "src/plugins/presentation_util/common/labs.ts", + "lineNumber": 38 + }, + "signature": [ + "true" + ] + }, + { + "tags": [], + "id": "def-common.projects.USE_DATA_SERVICE.isDisplayed", + "type": "boolean", + "label": "isDisplayed", + "description": [], + "source": { + "path": "src/plugins/presentation_util/common/labs.ts", + "lineNumber": 39 + }, + "signature": [ + "true" + ] + }, + { + "tags": [], + "id": "def-common.projects.USE_DATA_SERVICE.environments", + "type": "Array", + "label": "environments", + "description": [], + "source": { + "path": "src/plugins/presentation_util/common/labs.ts", + "lineNumber": 40 + }, + "signature": [ + "(\"kibana\" | \"browser\" | \"session\")[]" + ] + }, + { + "tags": [], + "id": "def-common.projects.USE_DATA_SERVICE.name", + "type": "string", + "label": "name", + "description": [], + "source": { + "path": "src/plugins/presentation_util/common/labs.ts", + "lineNumber": 41 + } + }, + { + "tags": [], + "id": "def-common.projects.USE_DATA_SERVICE.description", + "type": "string", + "label": "description", + "description": [], + "source": { + "path": "src/plugins/presentation_util/common/labs.ts", + "lineNumber": 44 + } + }, + { + "tags": [], + "id": "def-common.projects.USE_DATA_SERVICE.solutions", + "type": "Array", + "label": "solutions", + "description": [], + "source": { + "path": "src/plugins/presentation_util/common/labs.ts", + "lineNumber": 50 + }, + "signature": [ + "\"canvas\"[]" + ] + } + ], + "description": [], + "label": "[USE_DATA_SERVICE]", + "source": { + "path": "src/plugins/presentation_util/common/labs.ts", + "lineNumber": 36 } } ], @@ -790,7 +1495,7 @@ "label": "projects", "source": { "path": "src/plugins/presentation_util/common/labs.ts", - "lineNumber": 21 + "lineNumber": 22 }, "initialIsOpen": false }, @@ -802,7 +1507,7 @@ "description": [], "source": { "path": "src/plugins/presentation_util/common/labs.ts", - "lineNumber": 15 + "lineNumber": 16 }, "signature": [ "readonly [\"canvas\", \"dashboard\", \"presentation\"]" diff --git a/api_docs/presentation_util.mdx b/api_docs/presentation_util.mdx index 4cb96b938bfa5..9416a74b8f42c 100644 --- a/api_docs/presentation_util.mdx +++ b/api_docs/presentation_util.mdx @@ -31,6 +31,11 @@ import presentationUtilObj from './presentation_util.json'; ### Consts, variables and types +## Server + +### Consts, variables and types + + ## Common ### Objects diff --git a/api_docs/remote_clusters.json b/api_docs/remote_clusters.json index c7c2517a9af58..349970c9ee84d 100644 --- a/api_docs/remote_clusters.json +++ b/api_docs/remote_clusters.json @@ -56,13 +56,13 @@ "description": [], "source": { "path": "x-pack/plugins/remote_clusters/server/plugin.ts", - "lineNumber": 23 + "lineNumber": 25 } } ], "source": { "path": "x-pack/plugins/remote_clusters/server/plugin.ts", - "lineNumber": 22 + "lineNumber": 24 }, "lifecycle": "setup", "initialIsOpen": true diff --git a/api_docs/reporting.json b/api_docs/reporting.json index 1afa9f51a1603..b5b47d53ac36d 100644 --- a/api_docs/reporting.json +++ b/api_docs/reporting.json @@ -584,7 +584,7 @@ "description": [], "source": { "path": "x-pack/plugins/reporting/public/plugin.ts", - "lineNumber": 107 + "lineNumber": 99 } } ], @@ -592,7 +592,7 @@ "returnComment": [], "source": { "path": "x-pack/plugins/reporting/public/plugin.ts", - "lineNumber": 107 + "lineNumber": 99 } }, { @@ -608,7 +608,7 @@ "section": "def-public.CoreSetup", "text": "CoreSetup" }, - ", { home, management, licensing, uiActions, share }: ", + ", setupDeps: ", "ReportingPublicPluginSetupDendencies", ") => ", { @@ -639,13 +639,13 @@ "description": [], "source": { "path": "x-pack/plugins/reporting/public/plugin.ts", - "lineNumber": 112 + "lineNumber": 110 } }, { "id": "def-public.ReportingPublicPlugin.setup.$2", "type": "Object", - "label": "{ home, management, licensing, uiActions, share }", + "label": "setupDeps", "isRequired": true, "signature": [ "ReportingPublicPluginSetupDendencies" @@ -653,7 +653,7 @@ "description": [], "source": { "path": "x-pack/plugins/reporting/public/plugin.ts", - "lineNumber": 113 + "lineNumber": 110 } } ], @@ -661,7 +661,7 @@ "returnComment": [], "source": { "path": "x-pack/plugins/reporting/public/plugin.ts", - "lineNumber": 111 + "lineNumber": 110 } }, { @@ -705,7 +705,7 @@ "description": [], "source": { "path": "x-pack/plugins/reporting/public/plugin.ts", - "lineNumber": 175 + "lineNumber": 190 } } ], @@ -713,7 +713,7 @@ "returnComment": [], "source": { "path": "x-pack/plugins/reporting/public/plugin.ts", - "lineNumber": 175 + "lineNumber": 190 } }, { @@ -729,13 +729,13 @@ "returnComment": [], "source": { "path": "x-pack/plugins/reporting/public/plugin.ts", - "lineNumber": 194 + "lineNumber": 209 } } ], "source": { "path": "x-pack/plugins/reporting/public/plugin.ts", - "lineNumber": 85 + "lineNumber": 81 }, "initialIsOpen": false } @@ -772,7 +772,7 @@ "description": [], "source": { "path": "x-pack/plugins/reporting/public/index.ts", - "lineNumber": 23 + "lineNumber": 24 }, "signature": [ "ReportingSetup" @@ -790,6 +790,27 @@ "label": "ReportingCore", "description": [], "children": [ + { + "tags": [], + "id": "def-server.ReportingCore.getStartContract", + "type": "Function", + "label": "getStartContract", + "description": [], + "source": { + "path": "x-pack/plugins/reporting/server/core.ts", + "lineNumber": 70 + }, + "signature": [ + "() => ", + { + "pluginId": "reporting", + "scope": "server", + "docId": "kibReportingPluginApi", + "section": "def-server.ReportingSetup", + "text": "ReportingSetup" + } + ] + }, { "id": "def-server.ReportingCore.Unnamed", "type": "Function", @@ -810,7 +831,7 @@ "description": [], "source": { "path": "x-pack/plugins/reporting/server/core.ts", - "lineNumber": 69 + "lineNumber": 72 } }, { @@ -826,14 +847,14 @@ "section": "def-server.PluginInitializerContext", "text": "PluginInitializerContext" }, - "; }>; autoDownload: boolean; }>; timeouts: Readonly<{} & { openUrl: number | moment.Duration; waitForElements: number | moment.Duration; renderComplete: number | moment.Duration; }>; networkPolicy: Readonly<{} & { enabled: boolean; rules: Readonly<{ host?: string | undefined; protocol?: string | undefined; } & { allow: boolean; }>[]; }>; zoom: number; viewport: Readonly<{} & { height: number; width: number; }>; loadDelay: number | moment.Duration; maxAttempts: number; }>; roles: Readonly<{} & { allow: string[]; }>; kibanaServer: Readonly<{ port?: number | undefined; hostname?: string | undefined; protocol?: string | undefined; } & {}>; queue: Readonly<{} & { timeout: number | moment.Duration; pollInterval: number | moment.Duration; indexInterval: string; pollEnabled: boolean; pollIntervalErrorMultiplier: number; }>; csv: Readonly<{} & { scroll: Readonly<{} & { size: number; duration: string; }>; checkForFormulas: boolean; escapeFormulaValues: boolean; enablePanelActionDownload: boolean; maxSizeBytes: number | ", + "; }>; autoDownload: boolean; }>; timeouts: Readonly<{} & { openUrl: number | moment.Duration; waitForElements: number | moment.Duration; renderComplete: number | moment.Duration; }>; networkPolicy: Readonly<{} & { enabled: boolean; rules: Readonly<{ host?: string | undefined; protocol?: string | undefined; } & { allow: boolean; }>[]; }>; zoom: number; viewport: Readonly<{} & { height: number; width: number; }>; loadDelay: number | moment.Duration; maxAttempts: number; }>; roles: Readonly<{} & { enabled: boolean; allow: string[]; }>; kibanaServer: Readonly<{ port?: number | undefined; hostname?: string | undefined; protocol?: string | undefined; } & {}>; queue: Readonly<{} & { timeout: number | moment.Duration; pollInterval: number | moment.Duration; indexInterval: string; pollEnabled: boolean; pollIntervalErrorMultiplier: number; }>; csv: Readonly<{} & { scroll: Readonly<{} & { size: number; duration: string; }>; checkForFormulas: boolean; escapeFormulaValues: boolean; enablePanelActionDownload: boolean; maxSizeBytes: number | ", "ByteSizeValue", "; useByteOrderMarkEncoding: boolean; }>; poll: Readonly<{} & { jobCompletionNotifier: Readonly<{} & { interval: number; intervalErrorMultiplier: number; }>; jobsRefresh: Readonly<{} & { interval: number; intervalErrorMultiplier: number; }>; }>; }>>" ], "description": [], "source": { "path": "x-pack/plugins/reporting/server/core.ts", - "lineNumber": 69 + "lineNumber": 72 } } ], @@ -841,7 +862,7 @@ "returnComment": [], "source": { "path": "x-pack/plugins/reporting/server/core.ts", - "lineNumber": 69 + "lineNumber": 72 } }, { @@ -866,7 +887,7 @@ "description": [], "source": { "path": "x-pack/plugins/reporting/server/core.ts", - "lineNumber": 79 + "lineNumber": 90 } } ], @@ -874,7 +895,7 @@ "returnComment": [], "source": { "path": "x-pack/plugins/reporting/server/core.ts", - "lineNumber": 79 + "lineNumber": 90 } }, { @@ -899,7 +920,7 @@ "description": [], "source": { "path": "x-pack/plugins/reporting/server/core.ts", - "lineNumber": 93 + "lineNumber": 104 } } ], @@ -907,7 +928,7 @@ "returnComment": [], "source": { "path": "x-pack/plugins/reporting/server/core.ts", - "lineNumber": 93 + "lineNumber": 104 } }, { @@ -923,7 +944,7 @@ "returnComment": [], "source": { "path": "x-pack/plugins/reporting/server/core.ts", - "lineNumber": 106 + "lineNumber": 117 } }, { @@ -939,7 +960,7 @@ "returnComment": [], "source": { "path": "x-pack/plugins/reporting/server/core.ts", - "lineNumber": 117 + "lineNumber": 128 } }, { @@ -955,7 +976,7 @@ "returnComment": [], "source": { "path": "x-pack/plugins/reporting/server/core.ts", - "lineNumber": 124 + "lineNumber": 135 } }, { @@ -992,7 +1013,7 @@ "description": [], "source": { "path": "x-pack/plugins/reporting/server/core.ts", - "lineNumber": 131 + "lineNumber": 142 } } ], @@ -1000,7 +1021,7 @@ "returnComment": [], "source": { "path": "x-pack/plugins/reporting/server/core.ts", - "lineNumber": 131 + "lineNumber": 142 } }, { @@ -1011,14 +1032,14 @@ "() => void" ], "description": [ - "\nRegisters reporting as an Elasticsearch feature for the purpose of toggling visibility based on roles." + "\nIf xpack.reporting.roles.enabled === true, register Reporting as a feature\nthat is controlled by user role names" ], "children": [], "tags": [], "returnComment": [], "source": { "path": "x-pack/plugins/reporting/server/core.ts", - "lineNumber": 139 + "lineNumber": 151 } }, { @@ -1041,7 +1062,23 @@ "returnComment": [], "source": { "path": "x-pack/plugins/reporting/server/core.ts", - "lineNumber": 159 + "lineNumber": 185 + } + }, + { + "id": "def-server.ReportingCore.getDeprecatedAllowedRoles", + "type": "Function", + "label": "getDeprecatedAllowedRoles", + "signature": [ + "() => false | string[]" + ], + "description": [], + "children": [], + "tags": [], + "returnComment": [], + "source": { + "path": "x-pack/plugins/reporting/server/core.ts", + "lineNumber": 197 } }, { @@ -1059,7 +1096,7 @@ "returnComment": [], "source": { "path": "x-pack/plugins/reporting/server/core.ts", - "lineNumber": 169 + "lineNumber": 204 } }, { @@ -1076,7 +1113,7 @@ "returnComment": [], "source": { "path": "x-pack/plugins/reporting/server/core.ts", - "lineNumber": 177 + "lineNumber": 212 } }, { @@ -1114,7 +1151,7 @@ "description": [], "source": { "path": "x-pack/plugins/reporting/server/core.ts", - "lineNumber": 181 + "lineNumber": 216 } } ], @@ -1122,7 +1159,7 @@ "returnComment": [], "source": { "path": "x-pack/plugins/reporting/server/core.ts", - "lineNumber": 181 + "lineNumber": 216 } }, { @@ -1140,7 +1177,7 @@ "returnComment": [], "source": { "path": "x-pack/plugins/reporting/server/core.ts", - "lineNumber": 185 + "lineNumber": 220 } }, { @@ -1158,7 +1195,7 @@ "returnComment": [], "source": { "path": "x-pack/plugins/reporting/server/core.ts", - "lineNumber": 189 + "lineNumber": 224 } }, { @@ -1176,7 +1213,7 @@ "returnComment": [], "source": { "path": "x-pack/plugins/reporting/server/core.ts", - "lineNumber": 199 + "lineNumber": 234 } }, { @@ -1193,30 +1230,7 @@ "returnComment": [], "source": { "path": "x-pack/plugins/reporting/server/core.ts", - "lineNumber": 208 - } - }, - { - "id": "def-server.ReportingCore.getElasticsearchService", - "type": "Function", - "label": "getElasticsearchService", - "signature": [ - "() => ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.ElasticsearchServiceSetup", - "text": "ElasticsearchServiceSetup" - } - ], - "description": [], - "children": [], - "tags": [], - "returnComment": [], - "source": { - "path": "x-pack/plugins/reporting/server/core.ts", - "lineNumber": 216 + "lineNumber": 243 } }, { @@ -1263,7 +1277,7 @@ "description": [], "source": { "path": "x-pack/plugins/reporting/server/core.ts", - "lineNumber": 225 + "lineNumber": 255 } } ], @@ -1271,7 +1285,7 @@ "returnComment": [], "source": { "path": "x-pack/plugins/reporting/server/core.ts", - "lineNumber": 225 + "lineNumber": 255 } }, { @@ -1311,7 +1325,7 @@ "description": [], "source": { "path": "x-pack/plugins/reporting/server/core.ts", - "lineNumber": 231 + "lineNumber": 261 } }, { @@ -1325,7 +1339,7 @@ "description": [], "source": { "path": "x-pack/plugins/reporting/server/core.ts", - "lineNumber": 231 + "lineNumber": 261 } } ], @@ -1333,7 +1347,7 @@ "returnComment": [], "source": { "path": "x-pack/plugins/reporting/server/core.ts", - "lineNumber": 231 + "lineNumber": 261 } }, { @@ -1366,7 +1380,7 @@ "description": [], "source": { "path": "x-pack/plugins/reporting/server/core.ts", - "lineNumber": 245 + "lineNumber": 275 } }, { @@ -1380,7 +1394,7 @@ "description": [], "source": { "path": "x-pack/plugins/reporting/server/core.ts", - "lineNumber": 245 + "lineNumber": 275 } }, { @@ -1394,7 +1408,7 @@ "description": [], "source": { "path": "x-pack/plugins/reporting/server/core.ts", - "lineNumber": 245 + "lineNumber": 275 } } ], @@ -1402,7 +1416,7 @@ "returnComment": [], "source": { "path": "x-pack/plugins/reporting/server/core.ts", - "lineNumber": 245 + "lineNumber": 275 } }, { @@ -1450,7 +1464,7 @@ "description": [], "source": { "path": "x-pack/plugins/reporting/server/core.ts", - "lineNumber": 265 + "lineNumber": 295 } }, { @@ -1464,7 +1478,7 @@ "description": [], "source": { "path": "x-pack/plugins/reporting/server/core.ts", - "lineNumber": 265 + "lineNumber": 295 } } ], @@ -1472,7 +1486,7 @@ "returnComment": [], "source": { "path": "x-pack/plugins/reporting/server/core.ts", - "lineNumber": 265 + "lineNumber": 295 } }, { @@ -1496,7 +1510,7 @@ "returnComment": [], "source": { "path": "x-pack/plugins/reporting/server/core.ts", - "lineNumber": 275 + "lineNumber": 305 } }, { @@ -1520,7 +1534,7 @@ "returnComment": [], "source": { "path": "x-pack/plugins/reporting/server/core.ts", - "lineNumber": 280 + "lineNumber": 310 } }, { @@ -1543,7 +1557,7 @@ "description": [], "source": { "path": "x-pack/plugins/reporting/server/core.ts", - "lineNumber": 285 + "lineNumber": 315 } } ], @@ -1551,7 +1565,7 @@ "returnComment": [], "source": { "path": "x-pack/plugins/reporting/server/core.ts", - "lineNumber": 285 + "lineNumber": 315 } }, { @@ -1574,7 +1588,7 @@ "description": [], "source": { "path": "x-pack/plugins/reporting/server/core.ts", - "lineNumber": 289 + "lineNumber": 319 } } ], @@ -1582,7 +1596,7 @@ "returnComment": [], "source": { "path": "x-pack/plugins/reporting/server/core.ts", - "lineNumber": 289 + "lineNumber": 319 } }, { @@ -1598,7 +1612,7 @@ "returnComment": [], "source": { "path": "x-pack/plugins/reporting/server/core.ts", - "lineNumber": 293 + "lineNumber": 323 } } ], @@ -1630,23 +1644,30 @@ "section": "def-server.Plugin", "text": "Plugin" }, - "" + ", ", + { + "pluginId": "reporting", + "scope": "server", + "docId": "kibReportingPluginApi", + "section": "def-server.ReportingSetupDeps", + "text": "ReportingSetupDeps" + } ], "children": [ { @@ -1661,7 +1682,7 @@ { "id": "def-server.ReportingPlugin.Unnamed.$1", "type": "Object", - "label": "context", + "label": "initContext", "isRequired": true, "signature": [ { @@ -1671,14 +1692,14 @@ "section": "def-server.PluginInitializerContext", "text": "PluginInitializerContext" }, - "; }>; autoDownload: boolean; }>; timeouts: Readonly<{} & { openUrl: number | moment.Duration; waitForElements: number | moment.Duration; renderComplete: number | moment.Duration; }>; networkPolicy: Readonly<{} & { enabled: boolean; rules: Readonly<{ host?: string | undefined; protocol?: string | undefined; } & { allow: boolean; }>[]; }>; zoom: number; viewport: Readonly<{} & { height: number; width: number; }>; loadDelay: number | moment.Duration; maxAttempts: number; }>; roles: Readonly<{} & { allow: string[]; }>; kibanaServer: Readonly<{ port?: number | undefined; hostname?: string | undefined; protocol?: string | undefined; } & {}>; queue: Readonly<{} & { timeout: number | moment.Duration; pollInterval: number | moment.Duration; indexInterval: string; pollEnabled: boolean; pollIntervalErrorMultiplier: number; }>; csv: Readonly<{} & { scroll: Readonly<{} & { size: number; duration: string; }>; checkForFormulas: boolean; escapeFormulaValues: boolean; enablePanelActionDownload: boolean; maxSizeBytes: number | ", + "; }>; autoDownload: boolean; }>; timeouts: Readonly<{} & { openUrl: number | moment.Duration; waitForElements: number | moment.Duration; renderComplete: number | moment.Duration; }>; networkPolicy: Readonly<{} & { enabled: boolean; rules: Readonly<{ host?: string | undefined; protocol?: string | undefined; } & { allow: boolean; }>[]; }>; zoom: number; viewport: Readonly<{} & { height: number; width: number; }>; loadDelay: number | moment.Duration; maxAttempts: number; }>; roles: Readonly<{} & { enabled: boolean; allow: string[]; }>; kibanaServer: Readonly<{ port?: number | undefined; hostname?: string | undefined; protocol?: string | undefined; } & {}>; queue: Readonly<{} & { timeout: number | moment.Duration; pollInterval: number | moment.Duration; indexInterval: string; pollEnabled: boolean; pollIntervalErrorMultiplier: number; }>; csv: Readonly<{} & { scroll: Readonly<{} & { size: number; duration: string; }>; checkForFormulas: boolean; escapeFormulaValues: boolean; enablePanelActionDownload: boolean; maxSizeBytes: number | ", "ByteSizeValue", "; useByteOrderMarkEncoding: boolean; }>; poll: Readonly<{} & { jobCompletionNotifier: Readonly<{} & { interval: number; intervalErrorMultiplier: number; }>; jobsRefresh: Readonly<{} & { interval: number; intervalErrorMultiplier: number; }>; }>; }>>" ], "description": [], "source": { "path": "x-pack/plugins/reporting/server/plugin.ts", - "lineNumber": 31 + "lineNumber": 30 } } ], @@ -1686,7 +1707,7 @@ "returnComment": [], "source": { "path": "x-pack/plugins/reporting/server/plugin.ts", - "lineNumber": 31 + "lineNumber": 30 } }, { @@ -1710,7 +1731,14 @@ "section": "def-server.ReportingSetupDeps", "text": "ReportingSetupDeps" }, - ") => {}" + ") => ", + { + "pluginId": "reporting", + "scope": "server", + "docId": "kibReportingPluginApi", + "section": "def-server.ReportingSetup", + "text": "ReportingSetup" + } ], "description": [], "children": [ @@ -1732,7 +1760,7 @@ "description": [], "source": { "path": "x-pack/plugins/reporting/server/plugin.ts", - "lineNumber": 37 + "lineNumber": 34 } }, { @@ -1752,7 +1780,7 @@ "description": [], "source": { "path": "x-pack/plugins/reporting/server/plugin.ts", - "lineNumber": 37 + "lineNumber": 34 } } ], @@ -1760,7 +1788,7 @@ "returnComment": [], "source": { "path": "x-pack/plugins/reporting/server/plugin.ts", - "lineNumber": 37 + "lineNumber": 34 } }, { @@ -1784,7 +1812,14 @@ "section": "def-server.ReportingStartDeps", "text": "ReportingStartDeps" }, - ") => {}" + ") => ", + { + "pluginId": "reporting", + "scope": "server", + "docId": "kibReportingPluginApi", + "section": "def-server.ReportingSetup", + "text": "ReportingSetup" + } ], "description": [], "children": [ @@ -1858,7 +1893,7 @@ "section": "def-server.ReportingConfig", "text": "ReportingConfig" }, - " extends Config; }>; autoDownload: boolean; }>; timeouts: Readonly<{} & { openUrl: number | moment.Duration; waitForElements: number | moment.Duration; renderComplete: number | moment.Duration; }>; networkPolicy: Readonly<{} & { enabled: boolean; rules: Readonly<{ host?: string | undefined; protocol?: string | undefined; } & { allow: boolean; }>[]; }>; zoom: number; viewport: Readonly<{} & { height: number; width: number; }>; loadDelay: number | moment.Duration; maxAttempts: number; }>; roles: Readonly<{} & { allow: string[]; }>; kibanaServer: Readonly<{ port?: number | undefined; hostname?: string | undefined; protocol?: string | undefined; } & {}>; queue: Readonly<{} & { timeout: number | moment.Duration; pollInterval: number | moment.Duration; indexInterval: string; pollEnabled: boolean; pollIntervalErrorMultiplier: number; }>; csv: Readonly<{} & { scroll: Readonly<{} & { size: number; duration: string; }>; checkForFormulas: boolean; escapeFormulaValues: boolean; enablePanelActionDownload: boolean; maxSizeBytes: number | ", + " extends Config; }>; autoDownload: boolean; }>; timeouts: Readonly<{} & { openUrl: number | moment.Duration; waitForElements: number | moment.Duration; renderComplete: number | moment.Duration; }>; networkPolicy: Readonly<{} & { enabled: boolean; rules: Readonly<{ host?: string | undefined; protocol?: string | undefined; } & { allow: boolean; }>[]; }>; zoom: number; viewport: Readonly<{} & { height: number; width: number; }>; loadDelay: number | moment.Duration; maxAttempts: number; }>; roles: Readonly<{} & { enabled: boolean; allow: string[]; }>; kibanaServer: Readonly<{ port?: number | undefined; hostname?: string | undefined; protocol?: string | undefined; } & {}>; queue: Readonly<{} & { timeout: number | moment.Duration; pollInterval: number | moment.Duration; indexInterval: string; pollEnabled: boolean; pollIntervalErrorMultiplier: number; }>; csv: Readonly<{} & { scroll: Readonly<{} & { size: number; duration: string; }>; checkForFormulas: boolean; escapeFormulaValues: boolean; enablePanelActionDownload: boolean; maxSizeBytes: number | ", "ByteSizeValue", "; useByteOrderMarkEncoding: boolean; }>; poll: Readonly<{} & { jobCompletionNotifier: Readonly<{} & { interval: number; intervalErrorMultiplier: number; }>; jobsRefresh: Readonly<{} & { interval: number; intervalErrorMultiplier: number; }>; }>; }>>" ], @@ -2006,9 +2041,14 @@ "lineNumber": 34 }, "signature": [ - "Pick<", - "CollectorSet", - ", \"makeStatsCollector\" | \"makeUsageCollector\" | \"registerCollector\" | \"getCollectorByType\" | \"areAllCollectorsReady\" | \"bulkFetch\" | \"bulkFetchUsage\" | \"toObject\" | \"toApiFieldNames\"> | undefined" + { + "pluginId": "usageCollection", + "scope": "server", + "docId": "kibUsageCollectionPluginApi", + "section": "def-server.UsageCollectionSetup", + "text": "UsageCollectionSetup" + }, + " | undefined" ] } ], @@ -2075,7 +2115,36 @@ ], "enums": [], "misc": [], - "objects": [] + "objects": [], + "start": { + "id": "def-server.ReportingSetup", + "type": "Interface", + "label": "ReportingSetup", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-server.ReportingSetup.usesUiCapabilities", + "type": "Function", + "label": "usesUiCapabilities", + "description": [], + "source": { + "path": "x-pack/plugins/reporting/server/types.ts", + "lineNumber": 43 + }, + "signature": [ + "() => boolean" + ] + } + ], + "source": { + "path": "x-pack/plugins/reporting/server/types.ts", + "lineNumber": 42 + }, + "lifecycle": "start", + "initialIsOpen": true + } }, "common": { "classes": [ diff --git a/api_docs/reporting.mdx b/api_docs/reporting.mdx index d9a09aa267229..445d38e4ec71b 100644 --- a/api_docs/reporting.mdx +++ b/api_docs/reporting.mdx @@ -24,6 +24,9 @@ import reportingObj from './reporting.json'; ## Server +### Start + + ### Classes diff --git a/api_docs/rule_registry.json b/api_docs/rule_registry.json index dfa6643c57bad..f45a03d8a0506 100644 --- a/api_docs/rule_registry.json +++ b/api_docs/rule_registry.json @@ -1,11 +1,383 @@ { "id": "ruleRegistry", "client": { - "classes": [], + "classes": [ + { + "id": "def-public.RuleRegistry", + "type": "Class", + "tags": [], + "label": "RuleRegistry", + "description": [], + "signature": [ + { + "pluginId": "ruleRegistry", + "scope": "public", + "docId": "kibRuleRegistryPluginApi", + "section": "def-public.RuleRegistry", + "text": "RuleRegistry" + }, + "" + ], + "children": [ + { + "tags": [], + "id": "def-public.RuleRegistry.types", + "type": "Array", + "label": "types", + "description": [], + "source": { + "path": "x-pack/plugins/rule_registry/public/rule_registry/index.ts", + "lineNumber": 12 + }, + "signature": [ + "TRuleType[]" + ] + }, + { + "id": "def-public.RuleRegistry.Unnamed", + "type": "Function", + "label": "Constructor", + "signature": [ + "any" + ], + "description": [], + "children": [ + { + "id": "def-public.RuleRegistry.Unnamed.$1", + "type": "Object", + "label": "options", + "isRequired": true, + "signature": [ + "RuleRegistryConstructorOptions", + "" + ], + "description": [], + "source": { + "path": "x-pack/plugins/rule_registry/public/rule_registry/index.ts", + "lineNumber": 14 + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "x-pack/plugins/rule_registry/public/rule_registry/index.ts", + "lineNumber": 14 + } + }, + { + "id": "def-public.RuleRegistry.getTypes", + "type": "Function", + "label": "getTypes", + "signature": [ + "() => TRuleType[]" + ], + "description": [], + "children": [], + "tags": [], + "returnComment": [], + "source": { + "path": "x-pack/plugins/rule_registry/public/rule_registry/index.ts", + "lineNumber": 16 + } + }, + { + "id": "def-public.RuleRegistry.getTypeByRuleId", + "type": "Function", + "label": "getTypeByRuleId", + "signature": [ + "(id: string) => TRuleType | undefined" + ], + "description": [], + "children": [ + { + "id": "def-public.RuleRegistry.getTypeByRuleId.$1", + "type": "string", + "label": "id", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "x-pack/plugins/rule_registry/public/rule_registry/index.ts", + "lineNumber": 20 + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "x-pack/plugins/rule_registry/public/rule_registry/index.ts", + "lineNumber": 20 + } + }, + { + "id": "def-public.RuleRegistry.registerType", + "type": "Function", + "label": "registerType", + "signature": [ + "(type: TRuleType) => void" + ], + "description": [], + "children": [ + { + "id": "def-public.RuleRegistry.registerType.$1", + "type": "Uncategorized", + "label": "type", + "isRequired": true, + "signature": [ + "TRuleType" + ], + "description": [], + "source": { + "path": "x-pack/plugins/rule_registry/public/rule_registry/index.ts", + "lineNumber": 24 + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "x-pack/plugins/rule_registry/public/rule_registry/index.ts", + "lineNumber": 24 + } + }, + { + "id": "def-public.RuleRegistry.create", + "type": "Function", + "children": [ + { + "id": "def-public.RuleRegistry.create.$1", + "type": "Object", + "label": "{ fieldMap, ctor }", + "isRequired": true, + "signature": [ + "{ fieldMap: TNextFieldMap; ctor?: (new (options: ", + "RuleRegistryConstructorOptions", + ") => TRuleRegistryInstance) | undefined; }" + ], + "description": [], + "source": { + "path": "x-pack/plugins/rule_registry/public/rule_registry/index.ts", + "lineNumber": 33 + } + } + ], + "signature": [ + " = ", + { + "pluginId": "ruleRegistry", + "scope": "public", + "docId": "kibRuleRegistryPluginApi", + "section": "def-public.IRuleRegistry", + "text": "IRuleRegistry" + }, + ">({ fieldMap, ctor }: { fieldMap: TNextFieldMap; ctor?: (new (options: ", + "RuleRegistryConstructorOptions", + ") => TRuleRegistryInstance) | undefined; }) => any" + ], + "description": [], + "label": "create", + "source": { + "path": "x-pack/plugins/rule_registry/public/rule_registry/index.ts", + "lineNumber": 33 + }, + "tags": [], + "returnComment": [] + } + ], + "source": { + "path": "x-pack/plugins/rule_registry/public/rule_registry/index.ts", + "lineNumber": 11 + }, + "initialIsOpen": false + } + ], "functions": [], - "interfaces": [], + "interfaces": [ + { + "id": "def-public.IRuleRegistry", + "type": "Interface", + "label": "IRuleRegistry", + "signature": [ + { + "pluginId": "ruleRegistry", + "scope": "public", + "docId": "kibRuleRegistryPluginApi", + "section": "def-public.IRuleRegistry", + "text": "IRuleRegistry" + }, + "" + ], + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-public.IRuleRegistry.create", + "type": "Function", + "label": "create", + "description": [], + "source": { + "path": "x-pack/plugins/rule_registry/public/rule_registry/types.ts", + "lineNumber": 52 + }, + "signature": [ + "CreateRuleRegistry", + "" + ] + }, + { + "id": "def-public.IRuleRegistry.registerType", + "type": "Function", + "label": "registerType", + "signature": [ + "(type: TRuleType) => void" + ], + "description": [], + "children": [ + { + "id": "def-public.IRuleRegistry.registerType.$1", + "type": "Uncategorized", + "label": "type", + "isRequired": true, + "signature": [ + "TRuleType" + ], + "description": [], + "source": { + "path": "x-pack/plugins/rule_registry/public/rule_registry/types.ts", + "lineNumber": 53 + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "x-pack/plugins/rule_registry/public/rule_registry/types.ts", + "lineNumber": 53 + } + }, + { + "id": "def-public.IRuleRegistry.getTypeByRuleId", + "type": "Function", + "label": "getTypeByRuleId", + "signature": [ + "(ruleId: string) => TRuleType" + ], + "description": [], + "children": [ + { + "id": "def-public.IRuleRegistry.getTypeByRuleId.$1", + "type": "string", + "label": "ruleId", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "x-pack/plugins/rule_registry/public/rule_registry/types.ts", + "lineNumber": 54 + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "x-pack/plugins/rule_registry/public/rule_registry/types.ts", + "lineNumber": 54 + } + }, + { + "id": "def-public.IRuleRegistry.getTypes", + "type": "Function", + "label": "getTypes", + "signature": [ + "() => TRuleType[]" + ], + "description": [], + "children": [], + "tags": [], + "returnComment": [], + "source": { + "path": "x-pack/plugins/rule_registry/public/rule_registry/types.ts", + "lineNumber": 55 + } + } + ], + "source": { + "path": "x-pack/plugins/rule_registry/public/rule_registry/types.ts", + "lineNumber": 47 + }, + "initialIsOpen": false + } + ], "enums": [], - "misc": [], + "misc": [ + { + "id": "def-public.RuleRegistryPublicPluginSetupContract", + "type": "Type", + "label": "RuleRegistryPublicPluginSetupContract", + "tags": [], + "description": [], + "source": { + "path": "x-pack/plugins/rule_registry/public/plugin.ts", + "lineNumber": 35 + }, + "signature": [ + "{ registry: 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; }; }, ", + { + "pluginId": "triggersActionsUi", + "scope": "public", + "docId": "kibTriggersActionsUiPluginApi", + "section": "def-public.AlertTypeModel", + "text": "AlertTypeModel" + }, + ">>; }" + ], + "initialIsOpen": false + }, + { + "id": "def-public.RuleType", + "type": "Type", + "label": "RuleType", + "tags": [], + "description": [], + "source": { + "path": "x-pack/plugins/rule_registry/public/rule_registry/types.ts", + "lineNumber": 16 + }, + "signature": [ + { + "pluginId": "triggersActionsUi", + "scope": "public", + "docId": "kibTriggersActionsUiPluginApi", + "section": "def-public.AlertTypeModel", + "text": "AlertTypeModel" + }, + ">" + ], + "initialIsOpen": false + } + ], "objects": [] }, "server": { @@ -46,61 +418,6 @@ "lineNumber": 60 }, "initialIsOpen": false - }, - { - "id": "def-server.pickWithPatterns", - "type": "Function", - "label": "pickWithPatterns", - "signature": [ - "(map: T, patterns: TPatterns) => Pick<{ [TFieldName in keyof T]: ", - "SetIntersection", - "<", - "ValuesType", - ", PatternMapOf[TFieldName]> extends never ? never : T[TFieldName]; }, { [Key in keyof { [TFieldName in keyof T]: ", - "SetIntersection", - "<", - "ValuesType", - ", PatternMapOf[TFieldName]> extends never ? never : T[TFieldName]; }]-?: [{ [TFieldName in keyof T]: ", - "SetIntersection" - ], - "description": [], - "children": [ - { - "id": "def-server.pickWithPatterns.$1", - "type": "Uncategorized", - "label": "map", - "isRequired": true, - "signature": [ - "T" - ], - "description": [], - "source": { - "path": "x-pack/plugins/rule_registry/server/rule_registry/field_map/pick_with_patterns.ts", - "lineNumber": 42 - } - }, - { - "id": "def-server.pickWithPatterns.$2", - "type": "Uncategorized", - "label": "patterns", - "isRequired": true, - "signature": [ - "TPatterns" - ], - "description": [], - "source": { - "path": "x-pack/plugins/rule_registry/server/rule_registry/field_map/pick_with_patterns.ts", - "lineNumber": 42 - } - } - ], - "tags": [], - "returnComment": [], - "source": { - "path": "x-pack/plugins/rule_registry/server/rule_registry/field_map/pick_with_patterns.ts", - "lineNumber": 39 - }, - "initialIsOpen": false } ], "interfaces": [ @@ -145,7 +462,7 @@ "description": [], "source": { "path": "x-pack/plugins/rule_registry/server/rule_registry/create_scoped_rule_registry_client/types.ts", - "lineNumber": 42 + "lineNumber": 43 } } ], @@ -153,7 +470,31 @@ "returnComment": [], "source": { "path": "x-pack/plugins/rule_registry/server/rule_registry/create_scoped_rule_registry_client/types.ts", - "lineNumber": 41 + "lineNumber": 42 + } + }, + { + "id": "def-server.ScopedRuleRegistryClient.getDynamicIndexPattern", + "type": "Function", + "label": "getDynamicIndexPattern", + "signature": [ + "() => Promise<{ title: string; timeFieldName: string; fields: ", + { + "pluginId": "data", + "scope": "server", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-server.FieldDescriptor", + "text": "FieldDescriptor" + }, + "[]; }>" + ], + "description": [], + "children": [], + "tags": [], + "returnComment": [], + "source": { + "path": "x-pack/plugins/rule_registry/server/rule_registry/create_scoped_rule_registry_client/types.ts", + "lineNumber": 48 } }, { @@ -161,16 +502,11 @@ "type": "Function", "label": "index", "signature": [ - "(doc: Pick<", - "Mutable", - "<{ [K in keyof Pick<{ [key in keyof MapTypeValues]: MapTypeValues[key][\"type\"]; }, { [Key in keyof { [key in keyof MapTypeValues]: MapTypeValues[key][\"required\"]; }]-?: [true] extends [{ [key in keyof MapTypeValues]: MapTypeValues[key][\"required\"]; }[Key]] ? [{ [key in keyof MapTypeValues]: MapTypeValues[key][\"required\"]; }[Key]] extends [{ [key in keyof MapTypeValues]: MapTypeValues[key][\"required\"]; }[Key] & true] ? Key : never : never; }[keyof TFieldMap]>]: ", - "OutputOf", - "]: MapTypeValues[key][\"type\"]; }, { [Key in keyof { [key in keyof MapTypeValues]: MapTypeValues[key][\"required\"]; }]-?: [true] extends [{ [key in keyof MapTypeValues]: MapTypeValues[key][\"required\"]; }[Key]] ? [{ [key in keyof MapTypeValues]: MapTypeValues[key][\"required\"]; }[Key]] extends [{ [key in keyof MapTypeValues]: MapTypeValues[key][\"required\"]; }[Key] & true] ? Key : never : never; }[keyof TFieldMap]>[K]>; } & { [K in keyof { [key in keyof MapTypeValues]: MapTypeValues[key][\"type\"]; }]?: ", - "OutputOf", - "<{ [key in keyof MapTypeValues]: MapTypeValues[key][\"type\"]; }[K]> | undefined; }>, Exclude | Exclude<{ [Key in keyof { [key in keyof MapTypeValues]: MapTypeValues[key][\"required\"]; }]-?: [true] extends [{ [key in keyof MapTypeValues]: MapTypeValues[key][\"required\"]; }[Key]] ? [{ [key in keyof MapTypeValues]: MapTypeValues[key][\"required\"]; }[Key]] extends [{ [key in keyof MapTypeValues]: MapTypeValues[key][\"required\"]; }[Key] & true] ? Key : never : never; }[keyof TFieldMap], ", - "PrepopulatedRuleEventFields" + "(doc: Pick>, Exclude<{ [key in keyof TFieldMap]: TFieldMap[key][\"required\"] extends true ? never : key; }[keyof TFieldMap], \"rule.uuid\" | \"rule.id\" | \"rule.name\" | \"rule.category\" | \"kibana.rac.producer\"> | Exclude<", + "SetDifference", + ", \"rule.uuid\" | \"rule.id\" | \"rule.name\" | \"rule.category\" | \"kibana.rac.producer\">>) => void" ], "description": [], "children": [ @@ -180,21 +516,16 @@ "label": "doc", "isRequired": true, "signature": [ - "Pick<", - "Mutable", - "<{ [K in keyof Pick<{ [key in keyof MapTypeValues]: MapTypeValues[key][\"type\"]; }, { [Key in keyof { [key in keyof MapTypeValues]: MapTypeValues[key][\"required\"]; }]-?: [true] extends [{ [key in keyof MapTypeValues]: MapTypeValues[key][\"required\"]; }[Key]] ? [{ [key in keyof MapTypeValues]: MapTypeValues[key][\"required\"]; }[Key]] extends [{ [key in keyof MapTypeValues]: MapTypeValues[key][\"required\"]; }[Key] & true] ? Key : never : never; }[keyof TFieldMap]>]: ", - "OutputOf", - "]: MapTypeValues[key][\"type\"]; }, { [Key in keyof { [key in keyof MapTypeValues]: MapTypeValues[key][\"required\"]; }]-?: [true] extends [{ [key in keyof MapTypeValues]: MapTypeValues[key][\"required\"]; }[Key]] ? [{ [key in keyof MapTypeValues]: MapTypeValues[key][\"required\"]; }[Key]] extends [{ [key in keyof MapTypeValues]: MapTypeValues[key][\"required\"]; }[Key] & true] ? Key : never : never; }[keyof TFieldMap]>[K]>; } & { [K in keyof { [key in keyof MapTypeValues]: MapTypeValues[key][\"type\"]; }]?: ", - "OutputOf", - "<{ [key in keyof MapTypeValues]: MapTypeValues[key][\"type\"]; }[K]> | undefined; }>, Exclude | Exclude<{ [Key in keyof { [key in keyof MapTypeValues]: MapTypeValues[key][\"required\"]; }]-?: [true] extends [{ [key in keyof MapTypeValues]: MapTypeValues[key][\"required\"]; }[Key]] ? [{ [key in keyof MapTypeValues]: MapTypeValues[key][\"required\"]; }[Key]] extends [{ [key in keyof MapTypeValues]: MapTypeValues[key][\"required\"]; }[Key] & true] ? Key : never : never; }[keyof TFieldMap], ", - "PrepopulatedRuleEventFields" + "Pick>, Exclude<{ [key in keyof TFieldMap]: TFieldMap[key][\"required\"] extends true ? never : key; }[keyof TFieldMap], \"rule.uuid\" | \"rule.id\" | \"rule.name\" | \"rule.category\" | \"kibana.rac.producer\"> | Exclude<", + "SetDifference", + ", \"rule.uuid\" | \"rule.id\" | \"rule.name\" | \"rule.category\" | \"kibana.rac.producer\">>" ], "description": [], "source": { "path": "x-pack/plugins/rule_registry/server/rule_registry/create_scoped_rule_registry_client/types.ts", - "lineNumber": 47 + "lineNumber": 53 } } ], @@ -202,7 +533,7 @@ "returnComment": [], "source": { "path": "x-pack/plugins/rule_registry/server/rule_registry/create_scoped_rule_registry_client/types.ts", - "lineNumber": 47 + "lineNumber": 53 } }, { @@ -210,16 +541,11 @@ "type": "Function", "label": "bulkIndex", "signature": [ - "(doc: Pick<", - "Mutable", - "<{ [K in keyof Pick<{ [key in keyof MapTypeValues]: MapTypeValues[key][\"type\"]; }, { [Key in keyof { [key in keyof MapTypeValues]: MapTypeValues[key][\"required\"]; }]-?: [true] extends [{ [key in keyof MapTypeValues]: MapTypeValues[key][\"required\"]; }[Key]] ? [{ [key in keyof MapTypeValues]: MapTypeValues[key][\"required\"]; }[Key]] extends [{ [key in keyof MapTypeValues]: MapTypeValues[key][\"required\"]; }[Key] & true] ? Key : never : never; }[keyof TFieldMap]>]: ", - "OutputOf", - "]: MapTypeValues[key][\"type\"]; }, { [Key in keyof { [key in keyof MapTypeValues]: MapTypeValues[key][\"required\"]; }]-?: [true] extends [{ [key in keyof MapTypeValues]: MapTypeValues[key][\"required\"]; }[Key]] ? [{ [key in keyof MapTypeValues]: MapTypeValues[key][\"required\"]; }[Key]] extends [{ [key in keyof MapTypeValues]: MapTypeValues[key][\"required\"]; }[Key] & true] ? Key : never : never; }[keyof TFieldMap]>[K]>; } & { [K in keyof { [key in keyof MapTypeValues]: MapTypeValues[key][\"type\"]; }]?: ", - "OutputOf", - "<{ [key in keyof MapTypeValues]: MapTypeValues[key][\"type\"]; }[K]> | undefined; }>, Exclude | Exclude<{ [Key in keyof { [key in keyof MapTypeValues]: MapTypeValues[key][\"required\"]; }]-?: [true] extends [{ [key in keyof MapTypeValues]: MapTypeValues[key][\"required\"]; }[Key]] ? [{ [key in keyof MapTypeValues]: MapTypeValues[key][\"required\"]; }[Key]] extends [{ [key in keyof MapTypeValues]: MapTypeValues[key][\"required\"]; }[Key] & true] ? Key : never : never; }[keyof TFieldMap], ", - "PrepopulatedRuleEventFields" + "(doc: Pick>, Exclude<{ [key in keyof TFieldMap]: TFieldMap[key][\"required\"] extends true ? never : key; }[keyof TFieldMap], \"rule.uuid\" | \"rule.id\" | \"rule.name\" | \"rule.category\" | \"kibana.rac.producer\"> | Exclude<", + "SetDifference", + ", \"rule.uuid\" | \"rule.id\" | \"rule.name\" | \"rule.category\" | \"kibana.rac.producer\">>[]) => Promise" ], "description": [], "children": [ @@ -229,21 +555,16 @@ "label": "doc", "isRequired": true, "signature": [ - "Pick<", - "Mutable", - "<{ [K in keyof Pick<{ [key in keyof MapTypeValues]: MapTypeValues[key][\"type\"]; }, { [Key in keyof { [key in keyof MapTypeValues]: MapTypeValues[key][\"required\"]; }]-?: [true] extends [{ [key in keyof MapTypeValues]: MapTypeValues[key][\"required\"]; }[Key]] ? [{ [key in keyof MapTypeValues]: MapTypeValues[key][\"required\"]; }[Key]] extends [{ [key in keyof MapTypeValues]: MapTypeValues[key][\"required\"]; }[Key] & true] ? Key : never : never; }[keyof TFieldMap]>]: ", - "OutputOf", - "]: MapTypeValues[key][\"type\"]; }, { [Key in keyof { [key in keyof MapTypeValues]: MapTypeValues[key][\"required\"]; }]-?: [true] extends [{ [key in keyof MapTypeValues]: MapTypeValues[key][\"required\"]; }[Key]] ? [{ [key in keyof MapTypeValues]: MapTypeValues[key][\"required\"]; }[Key]] extends [{ [key in keyof MapTypeValues]: MapTypeValues[key][\"required\"]; }[Key] & true] ? Key : never : never; }[keyof TFieldMap]>[K]>; } & { [K in keyof { [key in keyof MapTypeValues]: MapTypeValues[key][\"type\"]; }]?: ", - "OutputOf", - "<{ [key in keyof MapTypeValues]: MapTypeValues[key][\"type\"]; }[K]> | undefined; }>, Exclude | Exclude<{ [Key in keyof { [key in keyof MapTypeValues]: MapTypeValues[key][\"required\"]; }]-?: [true] extends [{ [key in keyof MapTypeValues]: MapTypeValues[key][\"required\"]; }[Key]] ? [{ [key in keyof MapTypeValues]: MapTypeValues[key][\"required\"]; }[Key]] extends [{ [key in keyof MapTypeValues]: MapTypeValues[key][\"required\"]; }[Key] & true] ? Key : never : never; }[keyof TFieldMap], ", - "PrepopulatedRuleEventFields" + "Pick>, Exclude<{ [key in keyof TFieldMap]: TFieldMap[key][\"required\"] extends true ? never : key; }[keyof TFieldMap], \"rule.uuid\" | \"rule.id\" | \"rule.name\" | \"rule.category\" | \"kibana.rac.producer\"> | Exclude<", + "SetDifference", + ", \"rule.uuid\" | \"rule.id\" | \"rule.name\" | \"rule.category\" | \"kibana.rac.producer\">>[]" ], "description": [], "source": { "path": "x-pack/plugins/rule_registry/server/rule_registry/create_scoped_rule_registry_client/types.ts", - "lineNumber": 49 + "lineNumber": 55 } } ], @@ -251,13 +572,13 @@ "returnComment": [], "source": { "path": "x-pack/plugins/rule_registry/server/rule_registry/create_scoped_rule_registry_client/types.ts", - "lineNumber": 48 + "lineNumber": 54 } } ], "source": { "path": "x-pack/plugins/rule_registry/server/rule_registry/create_scoped_rule_registry_client/types.ts", - "lineNumber": 40 + "lineNumber": 41 }, "initialIsOpen": false } @@ -290,28 +611,12 @@ "lineNumber": 26 }, "signature": [ - "{ readonly enabled: boolean; readonly writeEnabled: boolean; }" - ], - "initialIsOpen": false - } - ], - "objects": [ - { - "tags": [], - "id": "def-server.ecsFieldMap", - "type": "Object", - "label": "ecsFieldMap", - "description": [], - "source": { - "path": "x-pack/plugins/rule_registry/server/generated/ecs_field_map.ts", - "lineNumber": 8 - }, - "signature": [ - "{ readonly '@timestamp': { readonly type: \"date\"; readonly array: false; readonly required: true; }; readonly 'agent.build.original': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'agent.ephemeral_id': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'agent.id': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'agent.name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'agent.type': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'agent.version': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'client.address': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'client.as.number': { readonly type: \"long\"; readonly array: false; readonly required: false; }; readonly 'client.as.organization.name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'client.bytes': { readonly type: \"long\"; readonly array: false; readonly required: false; }; readonly 'client.domain': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'client.geo.city_name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'client.geo.continent_name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'client.geo.country_iso_code': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'client.geo.country_name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'client.geo.location': { readonly type: \"geo_point\"; readonly array: false; readonly required: false; }; readonly 'client.geo.name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'client.geo.region_iso_code': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'client.geo.region_name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'client.ip': { readonly type: \"ip\"; readonly array: false; readonly required: false; }; readonly 'client.mac': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'client.nat.ip': { readonly type: \"ip\"; readonly array: false; readonly required: false; }; readonly 'client.nat.port': { readonly type: \"long\"; readonly array: false; readonly required: false; }; readonly 'client.packets': { readonly type: \"long\"; readonly array: false; readonly required: false; }; readonly 'client.port': { readonly type: \"long\"; readonly array: false; readonly required: false; }; readonly 'client.registered_domain': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'client.subdomain': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'client.top_level_domain': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'client.user.domain': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'client.user.email': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'client.user.full_name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'client.user.group.domain': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'client.user.group.id': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'client.user.group.name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'client.user.hash': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'client.user.id': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'client.user.name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'client.user.roles': { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly 'cloud.account.id': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'cloud.account.name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'cloud.availability_zone': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'cloud.instance.id': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'cloud.instance.name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'cloud.machine.type': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'cloud.project.id': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'cloud.project.name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'cloud.provider': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'cloud.region': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'container.id': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'container.image.name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'container.image.tag': { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly 'container.labels': { readonly type: \"object\"; readonly array: false; readonly required: false; }; readonly 'container.name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'container.runtime': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'destination.address': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'destination.as.number': { readonly type: \"long\"; readonly array: false; readonly required: false; }; readonly 'destination.as.organization.name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'destination.bytes': { readonly type: \"long\"; readonly array: false; readonly required: false; }; readonly 'destination.domain': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'destination.geo.city_name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'destination.geo.continent_name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'destination.geo.country_iso_code': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'destination.geo.country_name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'destination.geo.location': { readonly type: \"geo_point\"; readonly array: false; readonly required: false; }; readonly 'destination.geo.name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'destination.geo.region_iso_code': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'destination.geo.region_name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'destination.ip': { readonly type: \"ip\"; readonly array: false; readonly required: false; }; readonly 'destination.mac': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'destination.nat.ip': { readonly type: \"ip\"; readonly array: false; readonly required: false; }; readonly 'destination.nat.port': { readonly type: \"long\"; readonly array: false; readonly required: false; }; readonly 'destination.packets': { readonly type: \"long\"; readonly array: false; readonly required: false; }; readonly 'destination.port': { readonly type: \"long\"; readonly array: false; readonly required: false; }; readonly 'destination.registered_domain': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'destination.subdomain': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'destination.top_level_domain': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'destination.user.domain': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'destination.user.email': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'destination.user.full_name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'destination.user.group.domain': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'destination.user.group.id': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'destination.user.group.name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'destination.user.hash': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'destination.user.id': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'destination.user.name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'destination.user.roles': { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly 'dll.code_signature.exists': { readonly type: \"boolean\"; readonly array: false; readonly required: false; }; readonly 'dll.code_signature.status': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'dll.code_signature.subject_name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'dll.code_signature.trusted': { readonly type: \"boolean\"; readonly array: false; readonly required: false; }; readonly 'dll.code_signature.valid': { readonly type: \"boolean\"; readonly array: false; readonly required: false; }; readonly 'dll.hash.md5': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'dll.hash.sha1': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'dll.hash.sha256': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'dll.hash.sha512': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'dll.name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'dll.path': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'dll.pe.architecture': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'dll.pe.company': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'dll.pe.description': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'dll.pe.file_version': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'dll.pe.imphash': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'dll.pe.original_file_name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'dll.pe.product': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'dns.answers': { readonly type: \"object\"; readonly array: true; readonly required: false; }; readonly 'dns.answers.class': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'dns.answers.data': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'dns.answers.name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'dns.answers.ttl': { readonly type: \"long\"; readonly array: false; readonly required: false; }; readonly 'dns.answers.type': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'dns.header_flags': { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly 'dns.id': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'dns.op_code': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'dns.question.class': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'dns.question.name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'dns.question.registered_domain': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'dns.question.subdomain': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'dns.question.top_level_domain': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'dns.question.type': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'dns.resolved_ip': { readonly type: \"ip\"; readonly array: true; readonly required: false; }; readonly 'dns.response_code': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'dns.type': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'ecs.version': { readonly type: \"keyword\"; readonly array: false; readonly required: true; }; readonly 'error.code': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'error.id': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'error.message': { readonly type: \"text\"; readonly array: false; readonly required: false; }; readonly 'error.stack_trace': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'error.type': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'event.action': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'event.category': { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly 'event.code': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'event.created': { readonly type: \"date\"; readonly array: false; readonly required: false; }; readonly 'event.dataset': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'event.duration': { readonly type: \"long\"; readonly array: false; readonly required: false; }; readonly 'event.end': { readonly type: \"date\"; readonly array: false; readonly required: false; }; readonly 'event.hash': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'event.id': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'event.ingested': { readonly type: \"date\"; readonly array: false; readonly required: false; }; readonly 'event.kind': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'event.module': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'event.original': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'event.outcome': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'event.provider': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'event.reason': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'event.reference': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'event.risk_score': { readonly type: \"float\"; readonly array: false; readonly required: false; }; readonly 'event.risk_score_norm': { readonly type: \"float\"; readonly array: false; readonly required: false; }; readonly 'event.sequence': { readonly type: \"long\"; readonly array: false; readonly required: false; }; readonly 'event.severity': { readonly type: \"long\"; readonly array: false; readonly required: false; }; readonly 'event.start': { readonly type: \"date\"; readonly array: false; readonly required: false; }; readonly 'event.timezone': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'event.type': { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly 'event.url': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'file.accessed': { readonly type: \"date\"; readonly array: false; readonly required: false; }; readonly 'file.attributes': { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly 'file.code_signature.exists': { readonly type: \"boolean\"; readonly array: false; readonly required: false; }; readonly 'file.code_signature.status': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'file.code_signature.subject_name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'file.code_signature.trusted': { readonly type: \"boolean\"; readonly array: false; readonly required: false; }; readonly 'file.code_signature.valid': { readonly type: \"boolean\"; readonly array: false; readonly required: false; }; readonly 'file.created': { readonly type: \"date\"; readonly array: false; readonly required: false; }; readonly 'file.ctime': { readonly type: \"date\"; readonly array: false; readonly required: false; }; readonly 'file.device': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'file.directory': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'file.drive_letter': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'file.extension': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'file.gid': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'file.group': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'file.hash.md5': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'file.hash.sha1': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'file.hash.sha256': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'file.hash.sha512': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'file.inode': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'file.mime_type': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'file.mode': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'file.mtime': { readonly type: \"date\"; readonly array: false; readonly required: false; }; readonly 'file.name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'file.owner': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'file.path': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'file.pe.architecture': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'file.pe.company': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'file.pe.description': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'file.pe.file_version': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'file.pe.imphash': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'file.pe.original_file_name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'file.pe.product': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'file.size': { readonly type: \"long\"; readonly array: false; readonly required: false; }; readonly 'file.target_path': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'file.type': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'file.uid': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'file.x509.alternative_names': { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly 'file.x509.issuer.common_name': { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly 'file.x509.issuer.country': { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly 'file.x509.issuer.distinguished_name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'file.x509.issuer.locality': { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly 'file.x509.issuer.organization': { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly 'file.x509.issuer.organizational_unit': { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly 'file.x509.issuer.state_or_province': { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly 'file.x509.not_after': { readonly type: \"date\"; readonly array: false; readonly required: false; }; readonly 'file.x509.not_before': { readonly type: \"date\"; readonly array: false; readonly required: false; }; readonly 'file.x509.public_key_algorithm': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'file.x509.public_key_curve': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'file.x509.public_key_exponent': { readonly type: \"long\"; readonly array: false; readonly required: false; }; readonly 'file.x509.public_key_size': { readonly type: \"long\"; readonly array: false; readonly required: false; }; readonly 'file.x509.serial_number': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'file.x509.signature_algorithm': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'file.x509.subject.common_name': { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly 'file.x509.subject.country': { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly 'file.x509.subject.distinguished_name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'file.x509.subject.locality': { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly 'file.x509.subject.organization': { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly 'file.x509.subject.organizational_unit': { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly 'file.x509.subject.state_or_province': { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly 'file.x509.version_number': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'group.domain': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'group.id': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'group.name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'host.architecture': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'host.domain': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'host.geo.city_name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'host.geo.continent_name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'host.geo.country_iso_code': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'host.geo.country_name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'host.geo.location': { readonly type: \"geo_point\"; readonly array: false; readonly required: false; }; readonly 'host.geo.name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'host.geo.region_iso_code': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'host.geo.region_name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'host.hostname': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'host.id': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'host.ip': { readonly type: \"ip\"; readonly array: true; readonly required: false; }; readonly 'host.mac': { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly 'host.name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'host.os.family': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'host.os.full': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'host.os.kernel': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'host.os.name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'host.os.platform': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'host.os.type': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'host.os.version': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'host.type': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'host.uptime': { readonly type: \"long\"; readonly array: false; readonly required: false; }; readonly 'host.user.domain': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'host.user.email': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'host.user.full_name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'host.user.group.domain': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'host.user.group.id': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'host.user.group.name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'host.user.hash': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'host.user.id': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'host.user.name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'host.user.roles': { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly 'http.request.body.bytes': { readonly type: \"long\"; readonly array: false; readonly required: false; }; readonly 'http.request.body.content': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'http.request.bytes': { readonly type: \"long\"; readonly array: false; readonly required: false; }; readonly 'http.request.method': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'http.request.mime_type': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'http.request.referrer': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'http.response.body.bytes': { readonly type: \"long\"; readonly array: false; readonly required: false; }; readonly 'http.response.body.content': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'http.response.bytes': { readonly type: \"long\"; readonly array: false; readonly required: false; }; readonly 'http.response.mime_type': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'http.response.status_code': { readonly type: \"long\"; readonly array: false; readonly required: false; }; readonly 'http.version': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly labels: { readonly type: \"object\"; readonly array: false; readonly required: false; }; readonly 'log.file.path': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'log.level': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'log.logger': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'log.origin.file.line': { readonly type: \"integer\"; readonly array: false; readonly required: false; }; readonly 'log.origin.file.name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'log.origin.function': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'log.original': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'log.syslog': { readonly type: \"object\"; readonly array: false; readonly required: false; }; readonly 'log.syslog.facility.code': { readonly type: \"long\"; readonly array: false; readonly required: false; }; readonly 'log.syslog.facility.name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'log.syslog.priority': { readonly type: \"long\"; readonly array: false; readonly required: false; }; readonly 'log.syslog.severity.code': { readonly type: \"long\"; readonly array: false; readonly required: false; }; readonly 'log.syslog.severity.name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly message: { readonly type: \"text\"; readonly array: false; readonly required: false; }; readonly 'network.application': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'network.bytes': { readonly type: \"long\"; readonly array: false; readonly required: false; }; readonly 'network.community_id': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'network.direction': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'network.forwarded_ip': { readonly type: \"ip\"; readonly array: false; readonly required: false; }; readonly 'network.iana_number': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'network.inner': { readonly type: \"object\"; readonly array: false; readonly required: false; }; readonly 'network.inner.vlan.id': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'network.inner.vlan.name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'network.name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'network.packets': { readonly type: \"long\"; readonly array: false; readonly required: false; }; readonly 'network.protocol': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'network.transport': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'network.type': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'network.vlan.id': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'network.vlan.name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'observer.egress': { readonly type: \"object\"; readonly array: false; readonly required: false; }; readonly 'observer.egress.interface.alias': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'observer.egress.interface.id': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'observer.egress.interface.name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'observer.egress.vlan.id': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'observer.egress.vlan.name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'observer.egress.zone': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'observer.geo.city_name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'observer.geo.continent_name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'observer.geo.country_iso_code': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'observer.geo.country_name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'observer.geo.location': { readonly type: \"geo_point\"; readonly array: false; readonly required: false; }; readonly 'observer.geo.name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'observer.geo.region_iso_code': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'observer.geo.region_name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'observer.hostname': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'observer.ingress': { readonly type: \"object\"; readonly array: false; readonly required: false; }; readonly 'observer.ingress.interface.alias': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'observer.ingress.interface.id': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'observer.ingress.interface.name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'observer.ingress.vlan.id': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'observer.ingress.vlan.name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'observer.ingress.zone': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'observer.ip': { readonly type: \"ip\"; readonly array: true; readonly required: false; }; readonly 'observer.mac': { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly 'observer.name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'observer.os.family': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'observer.os.full': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'observer.os.kernel': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'observer.os.name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'observer.os.platform': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'observer.os.type': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'observer.os.version': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'observer.product': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'observer.serial_number': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'observer.type': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'observer.vendor': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'observer.version': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'organization.id': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'organization.name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'package.architecture': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'package.build_version': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'package.checksum': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'package.description': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'package.install_scope': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'package.installed': { readonly type: \"date\"; readonly array: false; readonly required: false; }; readonly 'package.license': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'package.name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'package.path': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'package.reference': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'package.size': { readonly type: \"long\"; readonly array: false; readonly required: false; }; readonly 'package.type': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'package.version': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'process.args': { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly 'process.args_count': { readonly type: \"long\"; readonly array: false; readonly required: false; }; readonly 'process.code_signature.exists': { readonly type: \"boolean\"; readonly array: false; readonly required: false; }; readonly 'process.code_signature.status': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'process.code_signature.subject_name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'process.code_signature.trusted': { readonly type: \"boolean\"; readonly array: false; readonly required: false; }; readonly 'process.code_signature.valid': { readonly type: \"boolean\"; readonly array: false; readonly required: false; }; readonly 'process.command_line': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'process.entity_id': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'process.executable': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'process.exit_code': { readonly type: \"long\"; readonly array: false; readonly required: false; }; readonly 'process.hash.md5': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'process.hash.sha1': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'process.hash.sha256': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'process.hash.sha512': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'process.name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'process.parent.args': { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly 'process.parent.args_count': { readonly type: \"long\"; readonly array: false; readonly required: false; }; readonly 'process.parent.code_signature.exists': { readonly type: \"boolean\"; readonly array: false; readonly required: false; }; readonly 'process.parent.code_signature.status': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'process.parent.code_signature.subject_name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'process.parent.code_signature.trusted': { readonly type: \"boolean\"; readonly array: false; readonly required: false; }; readonly 'process.parent.code_signature.valid': { readonly type: \"boolean\"; readonly array: false; readonly required: false; }; readonly 'process.parent.command_line': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'process.parent.entity_id': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'process.parent.executable': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'process.parent.exit_code': { readonly type: \"long\"; readonly array: false; readonly required: false; }; readonly 'process.parent.hash.md5': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'process.parent.hash.sha1': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'process.parent.hash.sha256': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'process.parent.hash.sha512': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'process.parent.name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'process.parent.pe.architecture': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'process.parent.pe.company': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'process.parent.pe.description': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'process.parent.pe.file_version': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'process.parent.pe.imphash': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'process.parent.pe.original_file_name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'process.parent.pe.product': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'process.parent.pgid': { readonly type: \"long\"; readonly array: false; readonly required: false; }; readonly 'process.parent.pid': { readonly type: \"long\"; readonly array: false; readonly required: false; }; readonly 'process.parent.ppid': { readonly type: \"long\"; readonly array: false; readonly required: false; }; readonly 'process.parent.start': { readonly type: \"date\"; readonly array: false; readonly required: false; }; readonly 'process.parent.thread.id': { readonly type: \"long\"; readonly array: false; readonly required: false; }; readonly 'process.parent.thread.name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'process.parent.title': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'process.parent.uptime': { readonly type: \"long\"; readonly array: false; readonly required: false; }; readonly 'process.parent.working_directory': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'process.pe.architecture': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'process.pe.company': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'process.pe.description': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'process.pe.file_version': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'process.pe.imphash': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'process.pe.original_file_name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'process.pe.product': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'process.pgid': { readonly type: \"long\"; readonly array: false; readonly required: false; }; readonly 'process.pid': { readonly type: \"long\"; readonly array: false; readonly required: false; }; readonly 'process.ppid': { readonly type: \"long\"; readonly array: false; readonly required: false; }; readonly 'process.start': { readonly type: \"date\"; readonly array: false; readonly required: false; }; readonly 'process.thread.id': { readonly type: \"long\"; readonly array: false; readonly required: false; }; readonly 'process.thread.name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'process.title': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'process.uptime': { readonly type: \"long\"; readonly array: false; readonly required: false; }; readonly 'process.working_directory': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'registry.data.bytes': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'registry.data.strings': { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly 'registry.data.type': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'registry.hive': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'registry.key': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'registry.path': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'registry.value': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'related.hash': { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly 'related.hosts': { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly 'related.ip': { readonly type: \"ip\"; readonly array: true; readonly required: false; }; readonly 'related.user': { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly 'rule.author': { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly 'rule.category': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'rule.description': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'rule.id': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'rule.license': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'rule.name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'rule.reference': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'rule.ruleset': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'rule.uuid': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'rule.version': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'server.address': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'server.as.number': { readonly type: \"long\"; readonly array: false; readonly required: false; }; readonly 'server.as.organization.name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'server.bytes': { readonly type: \"long\"; readonly array: false; readonly required: false; }; readonly 'server.domain': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'server.geo.city_name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'server.geo.continent_name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'server.geo.country_iso_code': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'server.geo.country_name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'server.geo.location': { readonly type: \"geo_point\"; readonly array: false; readonly required: false; }; readonly 'server.geo.name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'server.geo.region_iso_code': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'server.geo.region_name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'server.ip': { readonly type: \"ip\"; readonly array: false; readonly required: false; }; readonly 'server.mac': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'server.nat.ip': { readonly type: \"ip\"; readonly array: false; readonly required: false; }; readonly 'server.nat.port': { readonly type: \"long\"; readonly array: false; readonly required: false; }; readonly 'server.packets': { readonly type: \"long\"; readonly array: false; readonly required: false; }; readonly 'server.port': { readonly type: \"long\"; readonly array: false; readonly required: false; }; readonly 'server.registered_domain': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'server.subdomain': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'server.top_level_domain': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'server.user.domain': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'server.user.email': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'server.user.full_name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'server.user.group.domain': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'server.user.group.id': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'server.user.group.name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'server.user.hash': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'server.user.id': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'server.user.name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'server.user.roles': { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly 'service.ephemeral_id': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'service.id': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'service.name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'service.node.name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'service.state': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'service.type': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'service.version': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'source.address': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'source.as.number': { readonly type: \"long\"; readonly array: false; readonly required: false; }; readonly 'source.as.organization.name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'source.bytes': { readonly type: \"long\"; readonly array: false; readonly required: false; }; readonly 'source.domain': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'source.geo.city_name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'source.geo.continent_name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'source.geo.country_iso_code': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'source.geo.country_name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'source.geo.location': { readonly type: \"geo_point\"; readonly array: false; readonly required: false; }; readonly 'source.geo.name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'source.geo.region_iso_code': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'source.geo.region_name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'source.ip': { readonly type: \"ip\"; readonly array: false; readonly required: false; }; readonly 'source.mac': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'source.nat.ip': { readonly type: \"ip\"; readonly array: false; readonly required: false; }; readonly 'source.nat.port': { readonly type: \"long\"; readonly array: false; readonly required: false; }; readonly 'source.packets': { readonly type: \"long\"; readonly array: false; readonly required: false; }; readonly 'source.port': { readonly type: \"long\"; readonly array: false; readonly required: false; }; readonly 'source.registered_domain': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'source.subdomain': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'source.top_level_domain': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'source.user.domain': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'source.user.email': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'source.user.full_name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'source.user.group.domain': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'source.user.group.id': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'source.user.group.name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'source.user.hash': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'source.user.id': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'source.user.name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'source.user.roles': { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly 'span.id': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly tags: { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly 'threat.framework': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'threat.tactic.id': { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly 'threat.tactic.name': { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly 'threat.tactic.reference': { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly 'threat.technique.id': { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly 'threat.technique.name': { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly 'threat.technique.reference': { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly 'threat.technique.subtechnique.id': { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly 'threat.technique.subtechnique.name': { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly 'threat.technique.subtechnique.reference': { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly 'tls.cipher': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'tls.client.certificate': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'tls.client.certificate_chain': { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly 'tls.client.hash.md5': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'tls.client.hash.sha1': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'tls.client.hash.sha256': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'tls.client.issuer': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'tls.client.ja3': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'tls.client.not_after': { readonly type: \"date\"; readonly array: false; readonly required: false; }; readonly 'tls.client.not_before': { readonly type: \"date\"; readonly array: false; readonly required: false; }; readonly 'tls.client.server_name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'tls.client.subject': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'tls.client.supported_ciphers': { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly 'tls.client.x509.alternative_names': { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly 'tls.client.x509.issuer.common_name': { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly 'tls.client.x509.issuer.country': { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly 'tls.client.x509.issuer.distinguished_name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'tls.client.x509.issuer.locality': { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly 'tls.client.x509.issuer.organization': { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly 'tls.client.x509.issuer.organizational_unit': { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly 'tls.client.x509.issuer.state_or_province': { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly 'tls.client.x509.not_after': { readonly type: \"date\"; readonly array: false; readonly required: false; }; readonly 'tls.client.x509.not_before': { readonly type: \"date\"; readonly array: false; readonly required: false; }; readonly 'tls.client.x509.public_key_algorithm': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'tls.client.x509.public_key_curve': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'tls.client.x509.public_key_exponent': { readonly type: \"long\"; readonly array: false; readonly required: false; }; readonly 'tls.client.x509.public_key_size': { readonly type: \"long\"; readonly array: false; readonly required: false; }; readonly 'tls.client.x509.serial_number': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'tls.client.x509.signature_algorithm': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'tls.client.x509.subject.common_name': { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly 'tls.client.x509.subject.country': { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly 'tls.client.x509.subject.distinguished_name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'tls.client.x509.subject.locality': { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly 'tls.client.x509.subject.organization': { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly 'tls.client.x509.subject.organizational_unit': { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly 'tls.client.x509.subject.state_or_province': { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly 'tls.client.x509.version_number': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'tls.curve': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'tls.established': { readonly type: \"boolean\"; readonly array: false; readonly required: false; }; readonly 'tls.next_protocol': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'tls.resumed': { readonly type: \"boolean\"; readonly array: false; readonly required: false; }; readonly 'tls.server.certificate': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'tls.server.certificate_chain': { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly 'tls.server.hash.md5': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'tls.server.hash.sha1': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'tls.server.hash.sha256': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'tls.server.issuer': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'tls.server.ja3s': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'tls.server.not_after': { readonly type: \"date\"; readonly array: false; readonly required: false; }; readonly 'tls.server.not_before': { readonly type: \"date\"; readonly array: false; readonly required: false; }; readonly 'tls.server.subject': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'tls.server.x509.alternative_names': { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly 'tls.server.x509.issuer.common_name': { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly 'tls.server.x509.issuer.country': { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly 'tls.server.x509.issuer.distinguished_name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'tls.server.x509.issuer.locality': { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly 'tls.server.x509.issuer.organization': { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly 'tls.server.x509.issuer.organizational_unit': { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly 'tls.server.x509.issuer.state_or_province': { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly 'tls.server.x509.not_after': { readonly type: \"date\"; readonly array: false; readonly required: false; }; readonly 'tls.server.x509.not_before': { readonly type: \"date\"; readonly array: false; readonly required: false; }; readonly 'tls.server.x509.public_key_algorithm': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'tls.server.x509.public_key_curve': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'tls.server.x509.public_key_exponent': { readonly type: \"long\"; readonly array: false; readonly required: false; }; readonly 'tls.server.x509.public_key_size': { readonly type: \"long\"; readonly array: false; readonly required: false; }; readonly 'tls.server.x509.serial_number': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'tls.server.x509.signature_algorithm': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'tls.server.x509.subject.common_name': { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly 'tls.server.x509.subject.country': { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly 'tls.server.x509.subject.distinguished_name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'tls.server.x509.subject.locality': { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly 'tls.server.x509.subject.organization': { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly 'tls.server.x509.subject.organizational_unit': { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly 'tls.server.x509.subject.state_or_province': { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly 'tls.server.x509.version_number': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'tls.version': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'tls.version_protocol': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'trace.id': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'transaction.id': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'url.domain': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'url.extension': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'url.fragment': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'url.full': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'url.original': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'url.password': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'url.path': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'url.port': { readonly type: \"long\"; readonly array: false; readonly required: false; }; readonly 'url.query': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'url.registered_domain': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'url.scheme': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'url.subdomain': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'url.top_level_domain': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'url.username': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'user.changes.domain': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'user.changes.email': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'user.changes.full_name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'user.changes.group.domain': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'user.changes.group.id': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'user.changes.group.name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'user.changes.hash': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'user.changes.id': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'user.changes.name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'user.changes.roles': { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly 'user.domain': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'user.effective.domain': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'user.effective.email': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'user.effective.full_name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'user.effective.group.domain': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'user.effective.group.id': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'user.effective.group.name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'user.effective.hash': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'user.effective.id': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'user.effective.name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'user.effective.roles': { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly 'user.email': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'user.full_name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'user.group.domain': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'user.group.id': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'user.group.name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'user.hash': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'user.id': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'user.name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'user.roles': { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly 'user.target.domain': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'user.target.email': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'user.target.full_name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'user.target.group.domain': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'user.target.group.id': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'user.target.group.name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'user.target.hash': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'user.target.id': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'user.target.name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'user.target.roles': { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly 'user_agent.device.name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'user_agent.name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'user_agent.original': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'user_agent.os.family': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'user_agent.os.full': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'user_agent.os.kernel': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'user_agent.os.name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'user_agent.os.platform': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'user_agent.os.type': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'user_agent.os.version': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'user_agent.version': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'vulnerability.category': { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly 'vulnerability.classification': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'vulnerability.description': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'vulnerability.enumeration': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'vulnerability.id': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'vulnerability.reference': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'vulnerability.report_id': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'vulnerability.scanner.vendor': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'vulnerability.score.base': { readonly type: \"float\"; readonly array: false; readonly required: false; }; readonly 'vulnerability.score.environmental': { readonly type: \"float\"; readonly array: false; readonly required: false; }; readonly 'vulnerability.score.temporal': { readonly type: \"float\"; readonly array: false; readonly required: false; }; readonly 'vulnerability.score.version': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'vulnerability.severity': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; }" + "{ readonly enabled: boolean; readonly unsafe: Readonly<{} & { write: Readonly<{} & { enabled: boolean; }>; }>; }" ], "initialIsOpen": false } ], + "objects": [], "setup": { "id": "def-server.RuleRegistryPluginSetupContract", "type": "Type", @@ -333,68 +638,318 @@ "classes": [], "functions": [ { - "id": "def-common.getAlertSeverityLevelValue", + "id": "def-common.mergeFieldMaps", + "type": "Function", + "label": "mergeFieldMaps", + "signature": [ + "(first: T1, second: T2) => T1 & T2" + ], + "description": [], + "children": [ + { + "id": "def-common.mergeFieldMaps.$1", + "type": "Uncategorized", + "label": "first", + "isRequired": true, + "signature": [ + "T1" + ], + "description": [], + "source": { + "path": "x-pack/plugins/rule_registry/common/field_map/merge_field_maps.ts", + "lineNumber": 10 + } + }, + { + "id": "def-common.mergeFieldMaps.$2", + "type": "Uncategorized", + "label": "second", + "isRequired": true, + "signature": [ + "T2" + ], + "description": [], + "source": { + "path": "x-pack/plugins/rule_registry/common/field_map/merge_field_maps.ts", + "lineNumber": 11 + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "x-pack/plugins/rule_registry/common/field_map/merge_field_maps.ts", + "lineNumber": 9 + }, + "initialIsOpen": false + }, + { + "id": "def-common.pickWithPatterns", "type": "Function", - "label": "getAlertSeverityLevelValue", + "label": "pickWithPatterns", "signature": [ - "(level: ", + "(map: T, patterns: TPatterns) => Pick<{ [TFieldName in keyof T]: ", + "SetIntersection", + "<", + "ValuesType", + ", PatternMapOf[TFieldName]> extends never ? never : T[TFieldName]; }, { [Key in keyof { [TFieldName in keyof T]: ", + "SetIntersection", + "<", + "ValuesType", + ", PatternMapOf[TFieldName]> extends never ? never : T[TFieldName]; }]-?: [{ [TFieldName in keyof T]: ", + "SetIntersection" + ], + "description": [], + "children": [ + { + "id": "def-common.pickWithPatterns.$1", + "type": "Uncategorized", + "label": "map", + "isRequired": true, + "signature": [ + "T" + ], + "description": [], + "source": { + "path": "x-pack/plugins/rule_registry/common/pick_with_patterns/index.ts", + "lineNumber": 42 + } + }, + { + "id": "def-common.pickWithPatterns.$2", + "type": "Uncategorized", + "label": "patterns", + "isRequired": true, + "signature": [ + "TPatterns" + ], + "description": [], + "source": { + "path": "x-pack/plugins/rule_registry/common/pick_with_patterns/index.ts", + "lineNumber": 42 + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "x-pack/plugins/rule_registry/common/pick_with_patterns/index.ts", + "lineNumber": 39 + }, + "initialIsOpen": false + }, + { + "id": "def-common.runtimeTypeFromFieldMap", + "type": "Function", + "label": "runtimeTypeFromFieldMap", + "signature": [ + "(fieldMap: TFieldMap) => ", { "pluginId": "ruleRegistry", "scope": "common", "docId": "kibRuleRegistryPluginApi", - "section": "def-common.AlertSeverityLevel", - "text": "AlertSeverityLevel" + "section": "def-common.FieldMapType", + "text": "FieldMapType" }, - ") => number" + "" ], "description": [], "children": [ { - "id": "def-common.getAlertSeverityLevelValue.$1", - "type": "Enum", - "label": "level", + "id": "def-common.runtimeTypeFromFieldMap.$1", + "type": "Uncategorized", + "label": "fieldMap", "isRequired": true, "signature": [ - { - "pluginId": "ruleRegistry", - "scope": "common", - "docId": "kibRuleRegistryPluginApi", - "section": "def-common.AlertSeverityLevel", - "text": "AlertSeverityLevel" - } + "TFieldMap" ], "description": [], "source": { - "path": "x-pack/plugins/rule_registry/common/types.ts", - "lineNumber": 18 + "path": "x-pack/plugins/rule_registry/common/field_map/runtime_type_from_fieldmap.ts", + "lineNumber": 86 } } ], "tags": [], "returnComment": [], "source": { - "path": "x-pack/plugins/rule_registry/common/types.ts", - "lineNumber": 18 + "path": "x-pack/plugins/rule_registry/common/field_map/runtime_type_from_fieldmap.ts", + "lineNumber": 85 }, "initialIsOpen": false } ], - "interfaces": [], - "enums": [ + "interfaces": [ { - "id": "def-common.AlertSeverityLevel", - "type": "Enum", - "label": "AlertSeverityLevel", - "tags": [], + "id": "def-common.FieldMap", + "type": "Interface", + "label": "FieldMap", "description": [], + "tags": [], + "children": [ + { + "id": "def-common.FieldMap.Unnamed", + "type": "Any", + "label": "Unnamed", + "tags": [], + "description": [], + "source": { + "path": "x-pack/plugins/rule_registry/common/field_map/types.ts", + "lineNumber": 9 + }, + "signature": [ + "any" + ] + } + ], "source": { - "path": "x-pack/plugins/rule_registry/common/types.ts", + "path": "x-pack/plugins/rule_registry/common/field_map/types.ts", "lineNumber": 8 }, "initialIsOpen": false } ], - "misc": [], - "objects": [] + "enums": [], + "misc": [ + { + "id": "def-common.BaseRuleFieldMap", + "type": "Type", + "label": "BaseRuleFieldMap", + "tags": [], + "description": [], + "source": { + "path": "x-pack/plugins/rule_registry/common/field_map/base_rule_field_map.ts", + "lineNumber": 33 + }, + "signature": [ + "{ 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; }; }" + ], + "initialIsOpen": false + }, + { + "id": "def-common.EcsFieldMap", + "type": "Type", + "label": "EcsFieldMap", + "tags": [], + "description": [], + "source": { + "path": "x-pack/plugins/rule_registry/common/field_map/ecs_field_map.ts", + "lineNumber": 3380 + }, + "signature": [ + "{ readonly '@timestamp': { readonly type: \"date\"; readonly array: false; readonly required: true; }; readonly 'agent.build.original': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'agent.ephemeral_id': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'agent.id': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'agent.name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'agent.type': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'agent.version': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'client.address': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'client.as.number': { readonly type: \"long\"; readonly array: false; readonly required: false; }; readonly 'client.as.organization.name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'client.bytes': { readonly type: \"long\"; readonly array: false; readonly required: false; }; readonly 'client.domain': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'client.geo.city_name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'client.geo.continent_name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'client.geo.country_iso_code': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'client.geo.country_name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'client.geo.location': { readonly type: \"geo_point\"; readonly array: false; readonly required: false; }; readonly 'client.geo.name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'client.geo.region_iso_code': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'client.geo.region_name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'client.ip': { readonly type: \"ip\"; readonly array: false; readonly required: false; }; readonly 'client.mac': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'client.nat.ip': { readonly type: \"ip\"; readonly array: false; readonly required: false; }; readonly 'client.nat.port': { readonly type: \"long\"; readonly array: false; readonly required: false; }; readonly 'client.packets': { readonly type: \"long\"; readonly array: false; readonly required: false; }; readonly 'client.port': { readonly type: \"long\"; readonly array: false; readonly required: false; }; readonly 'client.registered_domain': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'client.subdomain': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'client.top_level_domain': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'client.user.domain': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'client.user.email': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'client.user.full_name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'client.user.group.domain': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'client.user.group.id': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'client.user.group.name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'client.user.hash': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'client.user.id': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'client.user.name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'client.user.roles': { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly 'cloud.account.id': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'cloud.account.name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'cloud.availability_zone': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'cloud.instance.id': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'cloud.instance.name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'cloud.machine.type': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'cloud.project.id': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'cloud.project.name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'cloud.provider': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'cloud.region': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'container.id': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'container.image.name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'container.image.tag': { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly 'container.labels': { readonly type: \"object\"; readonly array: false; readonly required: false; }; readonly 'container.name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'container.runtime': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'destination.address': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'destination.as.number': { readonly type: \"long\"; readonly array: false; readonly required: false; }; readonly 'destination.as.organization.name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'destination.bytes': { readonly type: \"long\"; readonly array: false; readonly required: false; }; readonly 'destination.domain': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'destination.geo.city_name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'destination.geo.continent_name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'destination.geo.country_iso_code': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'destination.geo.country_name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'destination.geo.location': { readonly type: \"geo_point\"; readonly array: false; readonly required: false; }; readonly 'destination.geo.name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'destination.geo.region_iso_code': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'destination.geo.region_name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'destination.ip': { readonly type: \"ip\"; readonly array: false; readonly required: false; }; readonly 'destination.mac': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'destination.nat.ip': { readonly type: \"ip\"; readonly array: false; readonly required: false; }; readonly 'destination.nat.port': { readonly type: \"long\"; readonly array: false; readonly required: false; }; readonly 'destination.packets': { readonly type: \"long\"; readonly array: false; readonly required: false; }; readonly 'destination.port': { readonly type: \"long\"; readonly array: false; readonly required: false; }; readonly 'destination.registered_domain': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'destination.subdomain': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'destination.top_level_domain': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'destination.user.domain': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'destination.user.email': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'destination.user.full_name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'destination.user.group.domain': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'destination.user.group.id': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'destination.user.group.name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'destination.user.hash': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'destination.user.id': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'destination.user.name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'destination.user.roles': { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly 'dll.code_signature.exists': { readonly type: \"boolean\"; readonly array: false; readonly required: false; }; readonly 'dll.code_signature.status': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'dll.code_signature.subject_name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'dll.code_signature.trusted': { readonly type: \"boolean\"; readonly array: false; readonly required: false; }; readonly 'dll.code_signature.valid': { readonly type: \"boolean\"; readonly array: false; readonly required: false; }; readonly 'dll.hash.md5': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'dll.hash.sha1': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'dll.hash.sha256': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'dll.hash.sha512': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'dll.name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'dll.path': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'dll.pe.architecture': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'dll.pe.company': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'dll.pe.description': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'dll.pe.file_version': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'dll.pe.imphash': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'dll.pe.original_file_name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'dll.pe.product': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'dns.answers': { readonly type: \"object\"; readonly array: true; readonly required: false; }; readonly 'dns.answers.class': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'dns.answers.data': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'dns.answers.name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'dns.answers.ttl': { readonly type: \"long\"; readonly array: false; readonly required: false; }; readonly 'dns.answers.type': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'dns.header_flags': { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly 'dns.id': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'dns.op_code': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'dns.question.class': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'dns.question.name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'dns.question.registered_domain': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'dns.question.subdomain': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'dns.question.top_level_domain': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'dns.question.type': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'dns.resolved_ip': { readonly type: \"ip\"; readonly array: true; readonly required: false; }; readonly 'dns.response_code': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'dns.type': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'ecs.version': { readonly type: \"keyword\"; readonly array: false; readonly required: true; }; readonly 'error.code': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'error.id': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'error.message': { readonly type: \"text\"; readonly array: false; readonly required: false; }; readonly 'error.stack_trace': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'error.type': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'event.action': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'event.category': { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly 'event.code': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'event.created': { readonly type: \"date\"; readonly array: false; readonly required: false; }; readonly 'event.dataset': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'event.duration': { readonly type: \"long\"; readonly array: false; readonly required: false; }; readonly 'event.end': { readonly type: \"date\"; readonly array: false; readonly required: false; }; readonly 'event.hash': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'event.id': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'event.ingested': { readonly type: \"date\"; readonly array: false; readonly required: false; }; readonly 'event.kind': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'event.module': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'event.original': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'event.outcome': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'event.provider': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'event.reason': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'event.reference': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'event.risk_score': { readonly type: \"float\"; readonly array: false; readonly required: false; }; readonly 'event.risk_score_norm': { readonly type: \"float\"; readonly array: false; readonly required: false; }; readonly 'event.sequence': { readonly type: \"long\"; readonly array: false; readonly required: false; }; readonly 'event.severity': { readonly type: \"long\"; readonly array: false; readonly required: false; }; readonly 'event.start': { readonly type: \"date\"; readonly array: false; readonly required: false; }; readonly 'event.timezone': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'event.type': { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly 'event.url': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'file.accessed': { readonly type: \"date\"; readonly array: false; readonly required: false; }; readonly 'file.attributes': { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly 'file.code_signature.exists': { readonly type: \"boolean\"; readonly array: false; readonly required: false; }; readonly 'file.code_signature.status': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'file.code_signature.subject_name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'file.code_signature.trusted': { readonly type: \"boolean\"; readonly array: false; readonly required: false; }; readonly 'file.code_signature.valid': { readonly type: \"boolean\"; readonly array: false; readonly required: false; }; readonly 'file.created': { readonly type: \"date\"; readonly array: false; readonly required: false; }; readonly 'file.ctime': { readonly type: \"date\"; readonly array: false; readonly required: false; }; readonly 'file.device': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'file.directory': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'file.drive_letter': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'file.extension': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'file.gid': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'file.group': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'file.hash.md5': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'file.hash.sha1': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'file.hash.sha256': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'file.hash.sha512': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'file.inode': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'file.mime_type': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'file.mode': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'file.mtime': { readonly type: \"date\"; readonly array: false; readonly required: false; }; readonly 'file.name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'file.owner': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'file.path': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'file.pe.architecture': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'file.pe.company': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'file.pe.description': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'file.pe.file_version': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'file.pe.imphash': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'file.pe.original_file_name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'file.pe.product': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'file.size': { readonly type: \"long\"; readonly array: false; readonly required: false; }; readonly 'file.target_path': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'file.type': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'file.uid': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'file.x509.alternative_names': { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly 'file.x509.issuer.common_name': { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly 'file.x509.issuer.country': { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly 'file.x509.issuer.distinguished_name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'file.x509.issuer.locality': { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly 'file.x509.issuer.organization': { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly 'file.x509.issuer.organizational_unit': { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly 'file.x509.issuer.state_or_province': { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly 'file.x509.not_after': { readonly type: \"date\"; readonly array: false; readonly required: false; }; readonly 'file.x509.not_before': { readonly type: \"date\"; readonly array: false; readonly required: false; }; readonly 'file.x509.public_key_algorithm': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'file.x509.public_key_curve': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'file.x509.public_key_exponent': { readonly type: \"long\"; readonly array: false; readonly required: false; }; readonly 'file.x509.public_key_size': { readonly type: \"long\"; readonly array: false; readonly required: false; }; readonly 'file.x509.serial_number': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'file.x509.signature_algorithm': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'file.x509.subject.common_name': { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly 'file.x509.subject.country': { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly 'file.x509.subject.distinguished_name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'file.x509.subject.locality': { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly 'file.x509.subject.organization': { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly 'file.x509.subject.organizational_unit': { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly 'file.x509.subject.state_or_province': { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly 'file.x509.version_number': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'group.domain': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'group.id': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'group.name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'host.architecture': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'host.domain': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'host.geo.city_name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'host.geo.continent_name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'host.geo.country_iso_code': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'host.geo.country_name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'host.geo.location': { readonly type: \"geo_point\"; readonly array: false; readonly required: false; }; readonly 'host.geo.name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'host.geo.region_iso_code': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'host.geo.region_name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'host.hostname': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'host.id': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'host.ip': { readonly type: \"ip\"; readonly array: true; readonly required: false; }; readonly 'host.mac': { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly 'host.name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'host.os.family': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'host.os.full': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'host.os.kernel': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'host.os.name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'host.os.platform': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'host.os.type': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'host.os.version': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'host.type': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'host.uptime': { readonly type: \"long\"; readonly array: false; readonly required: false; }; readonly 'host.user.domain': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'host.user.email': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'host.user.full_name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'host.user.group.domain': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'host.user.group.id': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'host.user.group.name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'host.user.hash': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'host.user.id': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'host.user.name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'host.user.roles': { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly 'http.request.body.bytes': { readonly type: \"long\"; readonly array: false; readonly required: false; }; readonly 'http.request.body.content': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'http.request.bytes': { readonly type: \"long\"; readonly array: false; readonly required: false; }; readonly 'http.request.method': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'http.request.mime_type': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'http.request.referrer': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'http.response.body.bytes': { readonly type: \"long\"; readonly array: false; readonly required: false; }; readonly 'http.response.body.content': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'http.response.bytes': { readonly type: \"long\"; readonly array: false; readonly required: false; }; readonly 'http.response.mime_type': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'http.response.status_code': { readonly type: \"long\"; readonly array: false; readonly required: false; }; readonly 'http.version': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly labels: { readonly type: \"object\"; readonly array: false; readonly required: false; }; readonly 'log.file.path': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'log.level': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'log.logger': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'log.origin.file.line': { readonly type: \"integer\"; readonly array: false; readonly required: false; }; readonly 'log.origin.file.name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'log.origin.function': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'log.original': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'log.syslog': { readonly type: \"object\"; readonly array: false; readonly required: false; }; readonly 'log.syslog.facility.code': { readonly type: \"long\"; readonly array: false; readonly required: false; }; readonly 'log.syslog.facility.name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'log.syslog.priority': { readonly type: \"long\"; readonly array: false; readonly required: false; }; readonly 'log.syslog.severity.code': { readonly type: \"long\"; readonly array: false; readonly required: false; }; readonly 'log.syslog.severity.name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly message: { readonly type: \"text\"; readonly array: false; readonly required: false; }; readonly 'network.application': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'network.bytes': { readonly type: \"long\"; readonly array: false; readonly required: false; }; readonly 'network.community_id': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'network.direction': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'network.forwarded_ip': { readonly type: \"ip\"; readonly array: false; readonly required: false; }; readonly 'network.iana_number': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'network.inner': { readonly type: \"object\"; readonly array: false; readonly required: false; }; readonly 'network.inner.vlan.id': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'network.inner.vlan.name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'network.name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'network.packets': { readonly type: \"long\"; readonly array: false; readonly required: false; }; readonly 'network.protocol': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'network.transport': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'network.type': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'network.vlan.id': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'network.vlan.name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'observer.egress': { readonly type: \"object\"; readonly array: false; readonly required: false; }; readonly 'observer.egress.interface.alias': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'observer.egress.interface.id': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'observer.egress.interface.name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'observer.egress.vlan.id': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'observer.egress.vlan.name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'observer.egress.zone': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'observer.geo.city_name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'observer.geo.continent_name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'observer.geo.country_iso_code': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'observer.geo.country_name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'observer.geo.location': { readonly type: \"geo_point\"; readonly array: false; readonly required: false; }; readonly 'observer.geo.name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'observer.geo.region_iso_code': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'observer.geo.region_name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'observer.hostname': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'observer.ingress': { readonly type: \"object\"; readonly array: false; readonly required: false; }; readonly 'observer.ingress.interface.alias': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'observer.ingress.interface.id': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'observer.ingress.interface.name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'observer.ingress.vlan.id': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'observer.ingress.vlan.name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'observer.ingress.zone': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'observer.ip': { readonly type: \"ip\"; readonly array: true; readonly required: false; }; readonly 'observer.mac': { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly 'observer.name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'observer.os.family': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'observer.os.full': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'observer.os.kernel': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'observer.os.name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'observer.os.platform': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'observer.os.type': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'observer.os.version': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'observer.product': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'observer.serial_number': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'observer.type': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'observer.vendor': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'observer.version': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'organization.id': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'organization.name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'package.architecture': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'package.build_version': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'package.checksum': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'package.description': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'package.install_scope': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'package.installed': { readonly type: \"date\"; readonly array: false; readonly required: false; }; readonly 'package.license': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'package.name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'package.path': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'package.reference': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'package.size': { readonly type: \"long\"; readonly array: false; readonly required: false; }; readonly 'package.type': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'package.version': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'process.args': { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly 'process.args_count': { readonly type: \"long\"; readonly array: false; readonly required: false; }; readonly 'process.code_signature.exists': { readonly type: \"boolean\"; readonly array: false; readonly required: false; }; readonly 'process.code_signature.status': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'process.code_signature.subject_name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'process.code_signature.trusted': { readonly type: \"boolean\"; readonly array: false; readonly required: false; }; readonly 'process.code_signature.valid': { readonly type: \"boolean\"; readonly array: false; readonly required: false; }; readonly 'process.command_line': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'process.entity_id': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'process.executable': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'process.exit_code': { readonly type: \"long\"; readonly array: false; readonly required: false; }; readonly 'process.hash.md5': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'process.hash.sha1': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'process.hash.sha256': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'process.hash.sha512': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'process.name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'process.parent.args': { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly 'process.parent.args_count': { readonly type: \"long\"; readonly array: false; readonly required: false; }; readonly 'process.parent.code_signature.exists': { readonly type: \"boolean\"; readonly array: false; readonly required: false; }; readonly 'process.parent.code_signature.status': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'process.parent.code_signature.subject_name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'process.parent.code_signature.trusted': { readonly type: \"boolean\"; readonly array: false; readonly required: false; }; readonly 'process.parent.code_signature.valid': { readonly type: \"boolean\"; readonly array: false; readonly required: false; }; readonly 'process.parent.command_line': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'process.parent.entity_id': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'process.parent.executable': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'process.parent.exit_code': { readonly type: \"long\"; readonly array: false; readonly required: false; }; readonly 'process.parent.hash.md5': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'process.parent.hash.sha1': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'process.parent.hash.sha256': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'process.parent.hash.sha512': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'process.parent.name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'process.parent.pe.architecture': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'process.parent.pe.company': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'process.parent.pe.description': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'process.parent.pe.file_version': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'process.parent.pe.imphash': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'process.parent.pe.original_file_name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'process.parent.pe.product': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'process.parent.pgid': { readonly type: \"long\"; readonly array: false; readonly required: false; }; readonly 'process.parent.pid': { readonly type: \"long\"; readonly array: false; readonly required: false; }; readonly 'process.parent.ppid': { readonly type: \"long\"; readonly array: false; readonly required: false; }; readonly 'process.parent.start': { readonly type: \"date\"; readonly array: false; readonly required: false; }; readonly 'process.parent.thread.id': { readonly type: \"long\"; readonly array: false; readonly required: false; }; readonly 'process.parent.thread.name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'process.parent.title': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'process.parent.uptime': { readonly type: \"long\"; readonly array: false; readonly required: false; }; readonly 'process.parent.working_directory': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'process.pe.architecture': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'process.pe.company': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'process.pe.description': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'process.pe.file_version': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'process.pe.imphash': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'process.pe.original_file_name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'process.pe.product': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'process.pgid': { readonly type: \"long\"; readonly array: false; readonly required: false; }; readonly 'process.pid': { readonly type: \"long\"; readonly array: false; readonly required: false; }; readonly 'process.ppid': { readonly type: \"long\"; readonly array: false; readonly required: false; }; readonly 'process.start': { readonly type: \"date\"; readonly array: false; readonly required: false; }; readonly 'process.thread.id': { readonly type: \"long\"; readonly array: false; readonly required: false; }; readonly 'process.thread.name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'process.title': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'process.uptime': { readonly type: \"long\"; readonly array: false; readonly required: false; }; readonly 'process.working_directory': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'registry.data.bytes': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'registry.data.strings': { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly 'registry.data.type': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'registry.hive': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'registry.key': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'registry.path': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'registry.value': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'related.hash': { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly 'related.hosts': { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly 'related.ip': { readonly type: \"ip\"; readonly array: true; readonly required: false; }; readonly 'related.user': { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly 'rule.author': { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly 'rule.category': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'rule.description': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'rule.id': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'rule.license': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'rule.name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'rule.reference': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'rule.ruleset': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'rule.uuid': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'rule.version': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'server.address': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'server.as.number': { readonly type: \"long\"; readonly array: false; readonly required: false; }; readonly 'server.as.organization.name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'server.bytes': { readonly type: \"long\"; readonly array: false; readonly required: false; }; readonly 'server.domain': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'server.geo.city_name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'server.geo.continent_name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'server.geo.country_iso_code': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'server.geo.country_name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'server.geo.location': { readonly type: \"geo_point\"; readonly array: false; readonly required: false; }; readonly 'server.geo.name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'server.geo.region_iso_code': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'server.geo.region_name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'server.ip': { readonly type: \"ip\"; readonly array: false; readonly required: false; }; readonly 'server.mac': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'server.nat.ip': { readonly type: \"ip\"; readonly array: false; readonly required: false; }; readonly 'server.nat.port': { readonly type: \"long\"; readonly array: false; readonly required: false; }; readonly 'server.packets': { readonly type: \"long\"; readonly array: false; readonly required: false; }; readonly 'server.port': { readonly type: \"long\"; readonly array: false; readonly required: false; }; readonly 'server.registered_domain': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'server.subdomain': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'server.top_level_domain': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'server.user.domain': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'server.user.email': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'server.user.full_name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'server.user.group.domain': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'server.user.group.id': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'server.user.group.name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'server.user.hash': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'server.user.id': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'server.user.name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'server.user.roles': { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly 'service.ephemeral_id': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'service.id': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'service.name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'service.node.name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'service.state': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'service.type': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'service.version': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'source.address': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'source.as.number': { readonly type: \"long\"; readonly array: false; readonly required: false; }; readonly 'source.as.organization.name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'source.bytes': { readonly type: \"long\"; readonly array: false; readonly required: false; }; readonly 'source.domain': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'source.geo.city_name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'source.geo.continent_name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'source.geo.country_iso_code': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'source.geo.country_name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'source.geo.location': { readonly type: \"geo_point\"; readonly array: false; readonly required: false; }; readonly 'source.geo.name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'source.geo.region_iso_code': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'source.geo.region_name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'source.ip': { readonly type: \"ip\"; readonly array: false; readonly required: false; }; readonly 'source.mac': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'source.nat.ip': { readonly type: \"ip\"; readonly array: false; readonly required: false; }; readonly 'source.nat.port': { readonly type: \"long\"; readonly array: false; readonly required: false; }; readonly 'source.packets': { readonly type: \"long\"; readonly array: false; readonly required: false; }; readonly 'source.port': { readonly type: \"long\"; readonly array: false; readonly required: false; }; readonly 'source.registered_domain': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'source.subdomain': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'source.top_level_domain': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'source.user.domain': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'source.user.email': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'source.user.full_name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'source.user.group.domain': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'source.user.group.id': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'source.user.group.name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'source.user.hash': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'source.user.id': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'source.user.name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'source.user.roles': { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly 'span.id': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly tags: { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly 'threat.framework': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'threat.tactic.id': { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly 'threat.tactic.name': { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly 'threat.tactic.reference': { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly 'threat.technique.id': { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly 'threat.technique.name': { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly 'threat.technique.reference': { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly 'threat.technique.subtechnique.id': { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly 'threat.technique.subtechnique.name': { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly 'threat.technique.subtechnique.reference': { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly 'tls.cipher': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'tls.client.certificate': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'tls.client.certificate_chain': { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly 'tls.client.hash.md5': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'tls.client.hash.sha1': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'tls.client.hash.sha256': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'tls.client.issuer': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'tls.client.ja3': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'tls.client.not_after': { readonly type: \"date\"; readonly array: false; readonly required: false; }; readonly 'tls.client.not_before': { readonly type: \"date\"; readonly array: false; readonly required: false; }; readonly 'tls.client.server_name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'tls.client.subject': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'tls.client.supported_ciphers': { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly 'tls.client.x509.alternative_names': { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly 'tls.client.x509.issuer.common_name': { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly 'tls.client.x509.issuer.country': { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly 'tls.client.x509.issuer.distinguished_name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'tls.client.x509.issuer.locality': { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly 'tls.client.x509.issuer.organization': { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly 'tls.client.x509.issuer.organizational_unit': { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly 'tls.client.x509.issuer.state_or_province': { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly 'tls.client.x509.not_after': { readonly type: \"date\"; readonly array: false; readonly required: false; }; readonly 'tls.client.x509.not_before': { readonly type: \"date\"; readonly array: false; readonly required: false; }; readonly 'tls.client.x509.public_key_algorithm': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'tls.client.x509.public_key_curve': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'tls.client.x509.public_key_exponent': { readonly type: \"long\"; readonly array: false; readonly required: false; }; readonly 'tls.client.x509.public_key_size': { readonly type: \"long\"; readonly array: false; readonly required: false; }; readonly 'tls.client.x509.serial_number': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'tls.client.x509.signature_algorithm': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'tls.client.x509.subject.common_name': { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly 'tls.client.x509.subject.country': { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly 'tls.client.x509.subject.distinguished_name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'tls.client.x509.subject.locality': { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly 'tls.client.x509.subject.organization': { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly 'tls.client.x509.subject.organizational_unit': { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly 'tls.client.x509.subject.state_or_province': { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly 'tls.client.x509.version_number': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'tls.curve': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'tls.established': { readonly type: \"boolean\"; readonly array: false; readonly required: false; }; readonly 'tls.next_protocol': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'tls.resumed': { readonly type: \"boolean\"; readonly array: false; readonly required: false; }; readonly 'tls.server.certificate': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'tls.server.certificate_chain': { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly 'tls.server.hash.md5': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'tls.server.hash.sha1': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'tls.server.hash.sha256': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'tls.server.issuer': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'tls.server.ja3s': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'tls.server.not_after': { readonly type: \"date\"; readonly array: false; readonly required: false; }; readonly 'tls.server.not_before': { readonly type: \"date\"; readonly array: false; readonly required: false; }; readonly 'tls.server.subject': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'tls.server.x509.alternative_names': { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly 'tls.server.x509.issuer.common_name': { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly 'tls.server.x509.issuer.country': { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly 'tls.server.x509.issuer.distinguished_name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'tls.server.x509.issuer.locality': { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly 'tls.server.x509.issuer.organization': { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly 'tls.server.x509.issuer.organizational_unit': { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly 'tls.server.x509.issuer.state_or_province': { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly 'tls.server.x509.not_after': { readonly type: \"date\"; readonly array: false; readonly required: false; }; readonly 'tls.server.x509.not_before': { readonly type: \"date\"; readonly array: false; readonly required: false; }; readonly 'tls.server.x509.public_key_algorithm': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'tls.server.x509.public_key_curve': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'tls.server.x509.public_key_exponent': { readonly type: \"long\"; readonly array: false; readonly required: false; }; readonly 'tls.server.x509.public_key_size': { readonly type: \"long\"; readonly array: false; readonly required: false; }; readonly 'tls.server.x509.serial_number': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'tls.server.x509.signature_algorithm': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'tls.server.x509.subject.common_name': { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly 'tls.server.x509.subject.country': { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly 'tls.server.x509.subject.distinguished_name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'tls.server.x509.subject.locality': { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly 'tls.server.x509.subject.organization': { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly 'tls.server.x509.subject.organizational_unit': { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly 'tls.server.x509.subject.state_or_province': { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly 'tls.server.x509.version_number': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'tls.version': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'tls.version_protocol': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'trace.id': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'transaction.id': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'url.domain': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'url.extension': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'url.fragment': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'url.full': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'url.original': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'url.password': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'url.path': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'url.port': { readonly type: \"long\"; readonly array: false; readonly required: false; }; readonly 'url.query': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'url.registered_domain': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'url.scheme': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'url.subdomain': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'url.top_level_domain': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'url.username': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'user.changes.domain': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'user.changes.email': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'user.changes.full_name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'user.changes.group.domain': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'user.changes.group.id': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'user.changes.group.name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'user.changes.hash': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'user.changes.id': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'user.changes.name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'user.changes.roles': { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly 'user.domain': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'user.effective.domain': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'user.effective.email': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'user.effective.full_name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'user.effective.group.domain': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'user.effective.group.id': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'user.effective.group.name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'user.effective.hash': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'user.effective.id': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'user.effective.name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'user.effective.roles': { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly 'user.email': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'user.full_name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'user.group.domain': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'user.group.id': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'user.group.name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'user.hash': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'user.id': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'user.name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'user.roles': { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly 'user.target.domain': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'user.target.email': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'user.target.full_name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'user.target.group.domain': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'user.target.group.id': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'user.target.group.name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'user.target.hash': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'user.target.id': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'user.target.name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'user.target.roles': { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly 'user_agent.device.name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'user_agent.name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'user_agent.original': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'user_agent.os.family': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'user_agent.os.full': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'user_agent.os.kernel': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'user_agent.os.name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'user_agent.os.platform': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'user_agent.os.type': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'user_agent.os.version': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'user_agent.version': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'vulnerability.category': { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly 'vulnerability.classification': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'vulnerability.description': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'vulnerability.enumeration': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'vulnerability.id': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'vulnerability.reference': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'vulnerability.report_id': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'vulnerability.scanner.vendor': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'vulnerability.score.base': { readonly type: \"float\"; readonly array: false; readonly required: false; }; readonly 'vulnerability.score.environmental': { readonly type: \"float\"; readonly array: false; readonly required: false; }; readonly 'vulnerability.score.temporal': { readonly type: \"float\"; readonly array: false; readonly required: false; }; readonly 'vulnerability.score.version': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'vulnerability.severity': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; }" + ], + "initialIsOpen": false + }, + { + "id": "def-common.FieldMapType", + "type": "Type", + "label": "FieldMapType", + "tags": [], + "description": [], + "source": { + "path": "x-pack/plugins/rule_registry/common/field_map/runtime_type_from_fieldmap.ts", + "lineNumber": 83 + }, + "signature": [ + "t.Type>, OutputOf>, unknown>" + ], + "initialIsOpen": false + }, + { + "id": "def-common.OutputOfFieldMap", + "type": "Type", + "label": "OutputOfFieldMap", + "tags": [], + "description": [], + "source": { + "path": "x-pack/plugins/rule_registry/common/field_map/runtime_type_from_fieldmap.ts", + "lineNumber": 81 + }, + "signature": [ + "{ [key in keyof Optional]: OutputOfField[key], undefined>>; }" + ], + "initialIsOpen": false + }, + { + "id": "def-common.PatternsUnionOf", + "type": "Type", + "label": "PatternsUnionOf", + "tags": [], + "description": [], + "source": { + "path": "x-pack/plugins/rule_registry/common/pick_with_patterns/index.ts", + "lineNumber": 37 + }, + "signature": [ + "\"*\" | ", + "ValuesType", + ">" + ], + "initialIsOpen": false + }, + { + "id": "def-common.PickWithPatterns", + "type": "Type", + "label": "PickWithPatterns", + "tags": [], + "description": [], + "source": { + "path": "x-pack/plugins/rule_registry/common/pick_with_patterns/index.ts", + "lineNumber": 22 + }, + "signature": [ + "{ [P in { [Key in keyof { [TFieldName in keyof T]: SetIntersection, PatternMapOf[TFieldName]> extends never ? never : T[TFieldName]; }]-?: [{ [TFieldName in keyof T]: SetIntersection, PatternMapOf[TFieldName]> extends never ? never : T[TFieldName]; }[Key]] extends [never] ? never : Key; }[keyof T]]: { [TFieldName in keyof T]: SetIntersection, PatternMapOf[TFieldName]> extends never ? never : T[TFieldName]; }[P]; }" + ], + "initialIsOpen": false + }, + { + "id": "def-common.TypeOfFieldMap", + "type": "Type", + "label": "TypeOfFieldMap", + "tags": [], + "description": [], + "source": { + "path": "x-pack/plugins/rule_registry/common/field_map/runtime_type_from_fieldmap.ts", + "lineNumber": 80 + }, + "signature": [ + "{ [key in keyof Optional]: TypeOfField[key], undefined>>; }" + ], + "initialIsOpen": false + } + ], + "objects": [ + { + "tags": [], + "id": "def-common.baseRuleFieldMap", + "type": "Object", + "label": "baseRuleFieldMap", + "description": [], + "source": { + "path": "x-pack/plugins/rule_registry/common/field_map/base_rule_field_map.ts", + "lineNumber": 10 + }, + "signature": [ + "{ 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; }; }" + ], + "initialIsOpen": false + }, + { + "tags": [], + "id": "def-common.ecsFieldMap", + "type": "Object", + "label": "ecsFieldMap", + "description": [], + "source": { + "path": "x-pack/plugins/rule_registry/common/field_map/ecs_field_map.ts", + "lineNumber": 12 + }, + "signature": [ + "{ readonly '@timestamp': { readonly type: \"date\"; readonly array: false; readonly required: true; }; readonly 'agent.build.original': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'agent.ephemeral_id': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'agent.id': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'agent.name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'agent.type': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'agent.version': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'client.address': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'client.as.number': { readonly type: \"long\"; readonly array: false; readonly required: false; }; readonly 'client.as.organization.name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'client.bytes': { readonly type: \"long\"; readonly array: false; readonly required: false; }; readonly 'client.domain': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'client.geo.city_name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'client.geo.continent_name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'client.geo.country_iso_code': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'client.geo.country_name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'client.geo.location': { readonly type: \"geo_point\"; readonly array: false; readonly required: false; }; readonly 'client.geo.name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'client.geo.region_iso_code': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'client.geo.region_name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'client.ip': { readonly type: \"ip\"; readonly array: false; readonly required: false; }; readonly 'client.mac': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'client.nat.ip': { readonly type: \"ip\"; readonly array: false; readonly required: false; }; readonly 'client.nat.port': { readonly type: \"long\"; readonly array: false; readonly required: false; }; readonly 'client.packets': { readonly type: \"long\"; readonly array: false; readonly required: false; }; readonly 'client.port': { readonly type: \"long\"; readonly array: false; readonly required: false; }; readonly 'client.registered_domain': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'client.subdomain': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'client.top_level_domain': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'client.user.domain': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'client.user.email': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'client.user.full_name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'client.user.group.domain': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'client.user.group.id': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'client.user.group.name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'client.user.hash': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'client.user.id': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'client.user.name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'client.user.roles': { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly 'cloud.account.id': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'cloud.account.name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'cloud.availability_zone': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'cloud.instance.id': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'cloud.instance.name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'cloud.machine.type': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'cloud.project.id': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'cloud.project.name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'cloud.provider': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'cloud.region': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'container.id': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'container.image.name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'container.image.tag': { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly 'container.labels': { readonly type: \"object\"; readonly array: false; readonly required: false; }; readonly 'container.name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'container.runtime': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'destination.address': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'destination.as.number': { readonly type: \"long\"; readonly array: false; readonly required: false; }; readonly 'destination.as.organization.name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'destination.bytes': { readonly type: \"long\"; readonly array: false; readonly required: false; }; readonly 'destination.domain': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'destination.geo.city_name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'destination.geo.continent_name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'destination.geo.country_iso_code': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'destination.geo.country_name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'destination.geo.location': { readonly type: \"geo_point\"; readonly array: false; readonly required: false; }; readonly 'destination.geo.name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'destination.geo.region_iso_code': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'destination.geo.region_name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'destination.ip': { readonly type: \"ip\"; readonly array: false; readonly required: false; }; readonly 'destination.mac': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'destination.nat.ip': { readonly type: \"ip\"; readonly array: false; readonly required: false; }; readonly 'destination.nat.port': { readonly type: \"long\"; readonly array: false; readonly required: false; }; readonly 'destination.packets': { readonly type: \"long\"; readonly array: false; readonly required: false; }; readonly 'destination.port': { readonly type: \"long\"; readonly array: false; readonly required: false; }; readonly 'destination.registered_domain': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'destination.subdomain': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'destination.top_level_domain': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'destination.user.domain': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'destination.user.email': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'destination.user.full_name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'destination.user.group.domain': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'destination.user.group.id': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'destination.user.group.name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'destination.user.hash': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'destination.user.id': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'destination.user.name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'destination.user.roles': { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly 'dll.code_signature.exists': { readonly type: \"boolean\"; readonly array: false; readonly required: false; }; readonly 'dll.code_signature.status': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'dll.code_signature.subject_name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'dll.code_signature.trusted': { readonly type: \"boolean\"; readonly array: false; readonly required: false; }; readonly 'dll.code_signature.valid': { readonly type: \"boolean\"; readonly array: false; readonly required: false; }; readonly 'dll.hash.md5': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'dll.hash.sha1': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'dll.hash.sha256': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'dll.hash.sha512': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'dll.name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'dll.path': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'dll.pe.architecture': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'dll.pe.company': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'dll.pe.description': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'dll.pe.file_version': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'dll.pe.imphash': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'dll.pe.original_file_name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'dll.pe.product': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'dns.answers': { readonly type: \"object\"; readonly array: true; readonly required: false; }; readonly 'dns.answers.class': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'dns.answers.data': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'dns.answers.name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'dns.answers.ttl': { readonly type: \"long\"; readonly array: false; readonly required: false; }; readonly 'dns.answers.type': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'dns.header_flags': { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly 'dns.id': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'dns.op_code': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'dns.question.class': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'dns.question.name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'dns.question.registered_domain': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'dns.question.subdomain': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'dns.question.top_level_domain': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'dns.question.type': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'dns.resolved_ip': { readonly type: \"ip\"; readonly array: true; readonly required: false; }; readonly 'dns.response_code': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'dns.type': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'ecs.version': { readonly type: \"keyword\"; readonly array: false; readonly required: true; }; readonly 'error.code': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'error.id': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'error.message': { readonly type: \"text\"; readonly array: false; readonly required: false; }; readonly 'error.stack_trace': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'error.type': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'event.action': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'event.category': { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly 'event.code': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'event.created': { readonly type: \"date\"; readonly array: false; readonly required: false; }; readonly 'event.dataset': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'event.duration': { readonly type: \"long\"; readonly array: false; readonly required: false; }; readonly 'event.end': { readonly type: \"date\"; readonly array: false; readonly required: false; }; readonly 'event.hash': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'event.id': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'event.ingested': { readonly type: \"date\"; readonly array: false; readonly required: false; }; readonly 'event.kind': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'event.module': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'event.original': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'event.outcome': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'event.provider': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'event.reason': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'event.reference': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'event.risk_score': { readonly type: \"float\"; readonly array: false; readonly required: false; }; readonly 'event.risk_score_norm': { readonly type: \"float\"; readonly array: false; readonly required: false; }; readonly 'event.sequence': { readonly type: \"long\"; readonly array: false; readonly required: false; }; readonly 'event.severity': { readonly type: \"long\"; readonly array: false; readonly required: false; }; readonly 'event.start': { readonly type: \"date\"; readonly array: false; readonly required: false; }; readonly 'event.timezone': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'event.type': { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly 'event.url': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'file.accessed': { readonly type: \"date\"; readonly array: false; readonly required: false; }; readonly 'file.attributes': { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly 'file.code_signature.exists': { readonly type: \"boolean\"; readonly array: false; readonly required: false; }; readonly 'file.code_signature.status': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'file.code_signature.subject_name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'file.code_signature.trusted': { readonly type: \"boolean\"; readonly array: false; readonly required: false; }; readonly 'file.code_signature.valid': { readonly type: \"boolean\"; readonly array: false; readonly required: false; }; readonly 'file.created': { readonly type: \"date\"; readonly array: false; readonly required: false; }; readonly 'file.ctime': { readonly type: \"date\"; readonly array: false; readonly required: false; }; readonly 'file.device': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'file.directory': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'file.drive_letter': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'file.extension': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'file.gid': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'file.group': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'file.hash.md5': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'file.hash.sha1': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'file.hash.sha256': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'file.hash.sha512': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'file.inode': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'file.mime_type': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'file.mode': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'file.mtime': { readonly type: \"date\"; readonly array: false; readonly required: false; }; readonly 'file.name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'file.owner': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'file.path': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'file.pe.architecture': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'file.pe.company': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'file.pe.description': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'file.pe.file_version': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'file.pe.imphash': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'file.pe.original_file_name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'file.pe.product': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'file.size': { readonly type: \"long\"; readonly array: false; readonly required: false; }; readonly 'file.target_path': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'file.type': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'file.uid': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'file.x509.alternative_names': { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly 'file.x509.issuer.common_name': { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly 'file.x509.issuer.country': { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly 'file.x509.issuer.distinguished_name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'file.x509.issuer.locality': { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly 'file.x509.issuer.organization': { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly 'file.x509.issuer.organizational_unit': { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly 'file.x509.issuer.state_or_province': { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly 'file.x509.not_after': { readonly type: \"date\"; readonly array: false; readonly required: false; }; readonly 'file.x509.not_before': { readonly type: \"date\"; readonly array: false; readonly required: false; }; readonly 'file.x509.public_key_algorithm': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'file.x509.public_key_curve': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'file.x509.public_key_exponent': { readonly type: \"long\"; readonly array: false; readonly required: false; }; readonly 'file.x509.public_key_size': { readonly type: \"long\"; readonly array: false; readonly required: false; }; readonly 'file.x509.serial_number': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'file.x509.signature_algorithm': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'file.x509.subject.common_name': { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly 'file.x509.subject.country': { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly 'file.x509.subject.distinguished_name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'file.x509.subject.locality': { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly 'file.x509.subject.organization': { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly 'file.x509.subject.organizational_unit': { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly 'file.x509.subject.state_or_province': { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly 'file.x509.version_number': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'group.domain': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'group.id': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'group.name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'host.architecture': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'host.domain': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'host.geo.city_name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'host.geo.continent_name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'host.geo.country_iso_code': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'host.geo.country_name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'host.geo.location': { readonly type: \"geo_point\"; readonly array: false; readonly required: false; }; readonly 'host.geo.name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'host.geo.region_iso_code': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'host.geo.region_name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'host.hostname': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'host.id': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'host.ip': { readonly type: \"ip\"; readonly array: true; readonly required: false; }; readonly 'host.mac': { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly 'host.name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'host.os.family': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'host.os.full': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'host.os.kernel': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'host.os.name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'host.os.platform': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'host.os.type': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'host.os.version': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'host.type': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'host.uptime': { readonly type: \"long\"; readonly array: false; readonly required: false; }; readonly 'host.user.domain': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'host.user.email': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'host.user.full_name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'host.user.group.domain': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'host.user.group.id': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'host.user.group.name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'host.user.hash': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'host.user.id': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'host.user.name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'host.user.roles': { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly 'http.request.body.bytes': { readonly type: \"long\"; readonly array: false; readonly required: false; }; readonly 'http.request.body.content': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'http.request.bytes': { readonly type: \"long\"; readonly array: false; readonly required: false; }; readonly 'http.request.method': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'http.request.mime_type': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'http.request.referrer': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'http.response.body.bytes': { readonly type: \"long\"; readonly array: false; readonly required: false; }; readonly 'http.response.body.content': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'http.response.bytes': { readonly type: \"long\"; readonly array: false; readonly required: false; }; readonly 'http.response.mime_type': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'http.response.status_code': { readonly type: \"long\"; readonly array: false; readonly required: false; }; readonly 'http.version': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly labels: { readonly type: \"object\"; readonly array: false; readonly required: false; }; readonly 'log.file.path': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'log.level': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'log.logger': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'log.origin.file.line': { readonly type: \"integer\"; readonly array: false; readonly required: false; }; readonly 'log.origin.file.name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'log.origin.function': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'log.original': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'log.syslog': { readonly type: \"object\"; readonly array: false; readonly required: false; }; readonly 'log.syslog.facility.code': { readonly type: \"long\"; readonly array: false; readonly required: false; }; readonly 'log.syslog.facility.name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'log.syslog.priority': { readonly type: \"long\"; readonly array: false; readonly required: false; }; readonly 'log.syslog.severity.code': { readonly type: \"long\"; readonly array: false; readonly required: false; }; readonly 'log.syslog.severity.name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly message: { readonly type: \"text\"; readonly array: false; readonly required: false; }; readonly 'network.application': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'network.bytes': { readonly type: \"long\"; readonly array: false; readonly required: false; }; readonly 'network.community_id': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'network.direction': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'network.forwarded_ip': { readonly type: \"ip\"; readonly array: false; readonly required: false; }; readonly 'network.iana_number': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'network.inner': { readonly type: \"object\"; readonly array: false; readonly required: false; }; readonly 'network.inner.vlan.id': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'network.inner.vlan.name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'network.name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'network.packets': { readonly type: \"long\"; readonly array: false; readonly required: false; }; readonly 'network.protocol': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'network.transport': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'network.type': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'network.vlan.id': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'network.vlan.name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'observer.egress': { readonly type: \"object\"; readonly array: false; readonly required: false; }; readonly 'observer.egress.interface.alias': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'observer.egress.interface.id': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'observer.egress.interface.name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'observer.egress.vlan.id': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'observer.egress.vlan.name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'observer.egress.zone': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'observer.geo.city_name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'observer.geo.continent_name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'observer.geo.country_iso_code': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'observer.geo.country_name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'observer.geo.location': { readonly type: \"geo_point\"; readonly array: false; readonly required: false; }; readonly 'observer.geo.name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'observer.geo.region_iso_code': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'observer.geo.region_name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'observer.hostname': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'observer.ingress': { readonly type: \"object\"; readonly array: false; readonly required: false; }; readonly 'observer.ingress.interface.alias': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'observer.ingress.interface.id': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'observer.ingress.interface.name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'observer.ingress.vlan.id': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'observer.ingress.vlan.name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'observer.ingress.zone': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'observer.ip': { readonly type: \"ip\"; readonly array: true; readonly required: false; }; readonly 'observer.mac': { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly 'observer.name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'observer.os.family': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'observer.os.full': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'observer.os.kernel': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'observer.os.name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'observer.os.platform': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'observer.os.type': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'observer.os.version': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'observer.product': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'observer.serial_number': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'observer.type': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'observer.vendor': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'observer.version': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'organization.id': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'organization.name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'package.architecture': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'package.build_version': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'package.checksum': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'package.description': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'package.install_scope': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'package.installed': { readonly type: \"date\"; readonly array: false; readonly required: false; }; readonly 'package.license': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'package.name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'package.path': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'package.reference': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'package.size': { readonly type: \"long\"; readonly array: false; readonly required: false; }; readonly 'package.type': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'package.version': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'process.args': { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly 'process.args_count': { readonly type: \"long\"; readonly array: false; readonly required: false; }; readonly 'process.code_signature.exists': { readonly type: \"boolean\"; readonly array: false; readonly required: false; }; readonly 'process.code_signature.status': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'process.code_signature.subject_name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'process.code_signature.trusted': { readonly type: \"boolean\"; readonly array: false; readonly required: false; }; readonly 'process.code_signature.valid': { readonly type: \"boolean\"; readonly array: false; readonly required: false; }; readonly 'process.command_line': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'process.entity_id': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'process.executable': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'process.exit_code': { readonly type: \"long\"; readonly array: false; readonly required: false; }; readonly 'process.hash.md5': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'process.hash.sha1': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'process.hash.sha256': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'process.hash.sha512': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'process.name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'process.parent.args': { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly 'process.parent.args_count': { readonly type: \"long\"; readonly array: false; readonly required: false; }; readonly 'process.parent.code_signature.exists': { readonly type: \"boolean\"; readonly array: false; readonly required: false; }; readonly 'process.parent.code_signature.status': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'process.parent.code_signature.subject_name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'process.parent.code_signature.trusted': { readonly type: \"boolean\"; readonly array: false; readonly required: false; }; readonly 'process.parent.code_signature.valid': { readonly type: \"boolean\"; readonly array: false; readonly required: false; }; readonly 'process.parent.command_line': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'process.parent.entity_id': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'process.parent.executable': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'process.parent.exit_code': { readonly type: \"long\"; readonly array: false; readonly required: false; }; readonly 'process.parent.hash.md5': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'process.parent.hash.sha1': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'process.parent.hash.sha256': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'process.parent.hash.sha512': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'process.parent.name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'process.parent.pe.architecture': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'process.parent.pe.company': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'process.parent.pe.description': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'process.parent.pe.file_version': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'process.parent.pe.imphash': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'process.parent.pe.original_file_name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'process.parent.pe.product': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'process.parent.pgid': { readonly type: \"long\"; readonly array: false; readonly required: false; }; readonly 'process.parent.pid': { readonly type: \"long\"; readonly array: false; readonly required: false; }; readonly 'process.parent.ppid': { readonly type: \"long\"; readonly array: false; readonly required: false; }; readonly 'process.parent.start': { readonly type: \"date\"; readonly array: false; readonly required: false; }; readonly 'process.parent.thread.id': { readonly type: \"long\"; readonly array: false; readonly required: false; }; readonly 'process.parent.thread.name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'process.parent.title': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'process.parent.uptime': { readonly type: \"long\"; readonly array: false; readonly required: false; }; readonly 'process.parent.working_directory': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'process.pe.architecture': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'process.pe.company': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'process.pe.description': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'process.pe.file_version': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'process.pe.imphash': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'process.pe.original_file_name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'process.pe.product': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'process.pgid': { readonly type: \"long\"; readonly array: false; readonly required: false; }; readonly 'process.pid': { readonly type: \"long\"; readonly array: false; readonly required: false; }; readonly 'process.ppid': { readonly type: \"long\"; readonly array: false; readonly required: false; }; readonly 'process.start': { readonly type: \"date\"; readonly array: false; readonly required: false; }; readonly 'process.thread.id': { readonly type: \"long\"; readonly array: false; readonly required: false; }; readonly 'process.thread.name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'process.title': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'process.uptime': { readonly type: \"long\"; readonly array: false; readonly required: false; }; readonly 'process.working_directory': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'registry.data.bytes': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'registry.data.strings': { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly 'registry.data.type': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'registry.hive': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'registry.key': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'registry.path': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'registry.value': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'related.hash': { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly 'related.hosts': { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly 'related.ip': { readonly type: \"ip\"; readonly array: true; readonly required: false; }; readonly 'related.user': { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly 'rule.author': { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly 'rule.category': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'rule.description': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'rule.id': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'rule.license': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'rule.name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'rule.reference': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'rule.ruleset': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'rule.uuid': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'rule.version': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'server.address': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'server.as.number': { readonly type: \"long\"; readonly array: false; readonly required: false; }; readonly 'server.as.organization.name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'server.bytes': { readonly type: \"long\"; readonly array: false; readonly required: false; }; readonly 'server.domain': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'server.geo.city_name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'server.geo.continent_name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'server.geo.country_iso_code': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'server.geo.country_name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'server.geo.location': { readonly type: \"geo_point\"; readonly array: false; readonly required: false; }; readonly 'server.geo.name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'server.geo.region_iso_code': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'server.geo.region_name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'server.ip': { readonly type: \"ip\"; readonly array: false; readonly required: false; }; readonly 'server.mac': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'server.nat.ip': { readonly type: \"ip\"; readonly array: false; readonly required: false; }; readonly 'server.nat.port': { readonly type: \"long\"; readonly array: false; readonly required: false; }; readonly 'server.packets': { readonly type: \"long\"; readonly array: false; readonly required: false; }; readonly 'server.port': { readonly type: \"long\"; readonly array: false; readonly required: false; }; readonly 'server.registered_domain': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'server.subdomain': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'server.top_level_domain': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'server.user.domain': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'server.user.email': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'server.user.full_name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'server.user.group.domain': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'server.user.group.id': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'server.user.group.name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'server.user.hash': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'server.user.id': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'server.user.name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'server.user.roles': { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly 'service.ephemeral_id': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'service.id': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'service.name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'service.node.name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'service.state': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'service.type': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'service.version': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'source.address': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'source.as.number': { readonly type: \"long\"; readonly array: false; readonly required: false; }; readonly 'source.as.organization.name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'source.bytes': { readonly type: \"long\"; readonly array: false; readonly required: false; }; readonly 'source.domain': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'source.geo.city_name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'source.geo.continent_name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'source.geo.country_iso_code': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'source.geo.country_name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'source.geo.location': { readonly type: \"geo_point\"; readonly array: false; readonly required: false; }; readonly 'source.geo.name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'source.geo.region_iso_code': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'source.geo.region_name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'source.ip': { readonly type: \"ip\"; readonly array: false; readonly required: false; }; readonly 'source.mac': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'source.nat.ip': { readonly type: \"ip\"; readonly array: false; readonly required: false; }; readonly 'source.nat.port': { readonly type: \"long\"; readonly array: false; readonly required: false; }; readonly 'source.packets': { readonly type: \"long\"; readonly array: false; readonly required: false; }; readonly 'source.port': { readonly type: \"long\"; readonly array: false; readonly required: false; }; readonly 'source.registered_domain': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'source.subdomain': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'source.top_level_domain': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'source.user.domain': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'source.user.email': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'source.user.full_name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'source.user.group.domain': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'source.user.group.id': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'source.user.group.name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'source.user.hash': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'source.user.id': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'source.user.name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'source.user.roles': { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly 'span.id': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly tags: { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly 'threat.framework': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'threat.tactic.id': { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly 'threat.tactic.name': { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly 'threat.tactic.reference': { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly 'threat.technique.id': { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly 'threat.technique.name': { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly 'threat.technique.reference': { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly 'threat.technique.subtechnique.id': { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly 'threat.technique.subtechnique.name': { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly 'threat.technique.subtechnique.reference': { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly 'tls.cipher': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'tls.client.certificate': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'tls.client.certificate_chain': { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly 'tls.client.hash.md5': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'tls.client.hash.sha1': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'tls.client.hash.sha256': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'tls.client.issuer': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'tls.client.ja3': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'tls.client.not_after': { readonly type: \"date\"; readonly array: false; readonly required: false; }; readonly 'tls.client.not_before': { readonly type: \"date\"; readonly array: false; readonly required: false; }; readonly 'tls.client.server_name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'tls.client.subject': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'tls.client.supported_ciphers': { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly 'tls.client.x509.alternative_names': { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly 'tls.client.x509.issuer.common_name': { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly 'tls.client.x509.issuer.country': { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly 'tls.client.x509.issuer.distinguished_name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'tls.client.x509.issuer.locality': { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly 'tls.client.x509.issuer.organization': { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly 'tls.client.x509.issuer.organizational_unit': { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly 'tls.client.x509.issuer.state_or_province': { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly 'tls.client.x509.not_after': { readonly type: \"date\"; readonly array: false; readonly required: false; }; readonly 'tls.client.x509.not_before': { readonly type: \"date\"; readonly array: false; readonly required: false; }; readonly 'tls.client.x509.public_key_algorithm': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'tls.client.x509.public_key_curve': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'tls.client.x509.public_key_exponent': { readonly type: \"long\"; readonly array: false; readonly required: false; }; readonly 'tls.client.x509.public_key_size': { readonly type: \"long\"; readonly array: false; readonly required: false; }; readonly 'tls.client.x509.serial_number': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'tls.client.x509.signature_algorithm': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'tls.client.x509.subject.common_name': { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly 'tls.client.x509.subject.country': { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly 'tls.client.x509.subject.distinguished_name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'tls.client.x509.subject.locality': { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly 'tls.client.x509.subject.organization': { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly 'tls.client.x509.subject.organizational_unit': { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly 'tls.client.x509.subject.state_or_province': { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly 'tls.client.x509.version_number': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'tls.curve': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'tls.established': { readonly type: \"boolean\"; readonly array: false; readonly required: false; }; readonly 'tls.next_protocol': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'tls.resumed': { readonly type: \"boolean\"; readonly array: false; readonly required: false; }; readonly 'tls.server.certificate': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'tls.server.certificate_chain': { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly 'tls.server.hash.md5': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'tls.server.hash.sha1': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'tls.server.hash.sha256': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'tls.server.issuer': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'tls.server.ja3s': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'tls.server.not_after': { readonly type: \"date\"; readonly array: false; readonly required: false; }; readonly 'tls.server.not_before': { readonly type: \"date\"; readonly array: false; readonly required: false; }; readonly 'tls.server.subject': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'tls.server.x509.alternative_names': { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly 'tls.server.x509.issuer.common_name': { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly 'tls.server.x509.issuer.country': { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly 'tls.server.x509.issuer.distinguished_name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'tls.server.x509.issuer.locality': { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly 'tls.server.x509.issuer.organization': { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly 'tls.server.x509.issuer.organizational_unit': { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly 'tls.server.x509.issuer.state_or_province': { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly 'tls.server.x509.not_after': { readonly type: \"date\"; readonly array: false; readonly required: false; }; readonly 'tls.server.x509.not_before': { readonly type: \"date\"; readonly array: false; readonly required: false; }; readonly 'tls.server.x509.public_key_algorithm': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'tls.server.x509.public_key_curve': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'tls.server.x509.public_key_exponent': { readonly type: \"long\"; readonly array: false; readonly required: false; }; readonly 'tls.server.x509.public_key_size': { readonly type: \"long\"; readonly array: false; readonly required: false; }; readonly 'tls.server.x509.serial_number': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'tls.server.x509.signature_algorithm': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'tls.server.x509.subject.common_name': { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly 'tls.server.x509.subject.country': { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly 'tls.server.x509.subject.distinguished_name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'tls.server.x509.subject.locality': { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly 'tls.server.x509.subject.organization': { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly 'tls.server.x509.subject.organizational_unit': { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly 'tls.server.x509.subject.state_or_province': { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly 'tls.server.x509.version_number': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'tls.version': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'tls.version_protocol': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'trace.id': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'transaction.id': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'url.domain': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'url.extension': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'url.fragment': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'url.full': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'url.original': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'url.password': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'url.path': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'url.port': { readonly type: \"long\"; readonly array: false; readonly required: false; }; readonly 'url.query': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'url.registered_domain': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'url.scheme': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'url.subdomain': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'url.top_level_domain': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'url.username': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'user.changes.domain': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'user.changes.email': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'user.changes.full_name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'user.changes.group.domain': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'user.changes.group.id': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'user.changes.group.name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'user.changes.hash': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'user.changes.id': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'user.changes.name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'user.changes.roles': { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly 'user.domain': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'user.effective.domain': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'user.effective.email': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'user.effective.full_name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'user.effective.group.domain': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'user.effective.group.id': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'user.effective.group.name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'user.effective.hash': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'user.effective.id': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'user.effective.name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'user.effective.roles': { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly 'user.email': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'user.full_name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'user.group.domain': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'user.group.id': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'user.group.name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'user.hash': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'user.id': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'user.name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'user.roles': { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly 'user.target.domain': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'user.target.email': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'user.target.full_name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'user.target.group.domain': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'user.target.group.id': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'user.target.group.name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'user.target.hash': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'user.target.id': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'user.target.name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'user.target.roles': { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly 'user_agent.device.name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'user_agent.name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'user_agent.original': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'user_agent.os.family': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'user_agent.os.full': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'user_agent.os.kernel': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'user_agent.os.name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'user_agent.os.platform': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'user_agent.os.type': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'user_agent.os.version': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'user_agent.version': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'vulnerability.category': { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly 'vulnerability.classification': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'vulnerability.description': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'vulnerability.enumeration': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'vulnerability.id': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'vulnerability.reference': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'vulnerability.report_id': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'vulnerability.scanner.vendor': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'vulnerability.score.base': { readonly type: \"float\"; readonly array: false; readonly required: false; }; readonly 'vulnerability.score.environmental': { readonly type: \"float\"; readonly array: false; readonly required: false; }; readonly 'vulnerability.score.temporal': { readonly type: \"float\"; readonly array: false; readonly required: false; }; readonly 'vulnerability.score.version': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'vulnerability.severity': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; }" + ], + "initialIsOpen": false + } + ] } } \ No newline at end of file diff --git a/api_docs/rule_registry.mdx b/api_docs/rule_registry.mdx index 0fdaed425ed67..450b2f3ee5d61 100644 --- a/api_docs/rule_registry.mdx +++ b/api_docs/rule_registry.mdx @@ -11,14 +11,22 @@ warning: This document is auto-generated and is meant to be viewed inside our ex import ruleRegistryObj from './rule_registry.json'; +## Client + +### Classes + + +### Interfaces + + +### Consts, variables and types + + ## Server ### Setup -### Objects - - ### Functions @@ -30,9 +38,15 @@ import ruleRegistryObj from './rule_registry.json'; ## Common +### Objects + + ### Functions -### Enums - +### Interfaces + + +### Consts, variables and types + diff --git a/api_docs/saved_objects_management.json b/api_docs/saved_objects_management.json index a2ca7e318bbb1..5e06c629e087c 100644 --- a/api_docs/saved_objects_management.json +++ b/api_docs/saved_objects_management.json @@ -626,6 +626,20 @@ "signature": [ "\"multiple\" | \"single\" | \"multiple-isolated\" | \"agnostic\" | undefined" ] + }, + { + "tags": [], + "id": "def-public.SavedObjectMetadata.hiddenType", + "type": "CompoundType", + "label": "hiddenType", + "description": [], + "source": { + "path": "src/plugins/saved_objects_management/common/types.ts", + "lineNumber": 22 + }, + "signature": [ + "boolean | undefined" + ] } ], "source": { @@ -651,7 +665,7 @@ "description": [], "source": { "path": "src/plugins/saved_objects_management/common/types.ts", - "lineNumber": 37 + "lineNumber": 38 } }, { @@ -662,7 +676,7 @@ "description": [], "source": { "path": "src/plugins/saved_objects_management/common/types.ts", - "lineNumber": 38 + "lineNumber": 39 } }, { @@ -673,7 +687,7 @@ "description": [], "source": { "path": "src/plugins/saved_objects_management/common/types.ts", - "lineNumber": 39 + "lineNumber": 40 }, "signature": [ { @@ -693,7 +707,7 @@ "description": [], "source": { "path": "src/plugins/saved_objects_management/common/types.ts", - "lineNumber": 40 + "lineNumber": 41 }, "signature": [ { @@ -708,7 +722,7 @@ ], "source": { "path": "src/plugins/saved_objects_management/common/types.ts", - "lineNumber": 36 + "lineNumber": 37 }, "initialIsOpen": false }, @@ -853,7 +867,7 @@ "section": "def-public.SavedObjectsManagementRecord", "text": "SavedObjectsManagementRecord" }, - ">, \"children\" | \"headers\" | \"onClick\" | \"onChange\" | \"color\" | \"onKeyDown\" | \"description\" | \"title\" | \"id\" | \"name\" | \"field\" | \"placeholder\" | \"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\" | \"width\" | \"render\" | \"align\" | \"abbr\" | \"footer\" | \"colSpan\" | \"rowSpan\" | \"scope\" | \"valign\" | \"dataType\" | \"isExpander\" | \"textOnly\" | \"truncateText\" | \"isMobileHeader\" | \"mobileOptions\" | \"hideForMobile\">" + ">, \"children\" | \"headers\" | \"onClick\" | \"onChange\" | \"color\" | \"onKeyDown\" | \"description\" | \"title\" | \"id\" | \"name\" | \"field\" | \"placeholder\" | \"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\" | \"width\" | \"render\" | \"align\" | \"readOnly\" | \"abbr\" | \"footer\" | \"colSpan\" | \"rowSpan\" | \"scope\" | \"valign\" | \"dataType\" | \"isExpander\" | \"textOnly\" | \"truncateText\" | \"isMobileHeader\" | \"mobileOptions\" | \"hideForMobile\">" ] } ], @@ -987,7 +1001,7 @@ "section": "def-server.SavedObjectsNamespaceType", "text": "SavedObjectsNamespaceType" }, - "; }" + "; hiddenType: boolean; }" ] }, { @@ -998,7 +1012,7 @@ "description": [], "source": { "path": "src/plugins/saved_objects_management/public/services/types/record.ts", - "lineNumber": 19 + "lineNumber": 20 }, "signature": [ "SavedObjectReference", @@ -1013,7 +1027,7 @@ "description": [], "source": { "path": "src/plugins/saved_objects_management/public/services/types/record.ts", - "lineNumber": 20 + "lineNumber": 21 }, "signature": [ "string[] | undefined" @@ -1110,7 +1124,7 @@ ], "source": { "path": "src/plugins/saved_objects_management/common/types.ts", - "lineNumber": 27 + "lineNumber": 28 }, "signature": [ "SavedObject & { meta: SavedObjectMetadata; }" @@ -1273,7 +1287,7 @@ "description": [], "source": { "path": "src/plugins/saved_objects_management/common/types.ts", - "lineNumber": 51 + "lineNumber": 52 }, "signature": [ { @@ -1294,7 +1308,7 @@ "description": [], "source": { "path": "src/plugins/saved_objects_management/common/types.ts", - "lineNumber": 52 + "lineNumber": 53 }, "signature": [ { @@ -1310,7 +1324,7 @@ ], "source": { "path": "src/plugins/saved_objects_management/common/types.ts", - "lineNumber": 50 + "lineNumber": 51 }, "initialIsOpen": false }, @@ -1329,7 +1343,7 @@ "description": [], "source": { "path": "src/plugins/saved_objects_management/common/types.ts", - "lineNumber": 44 + "lineNumber": 45 } }, { @@ -1340,7 +1354,7 @@ "description": [], "source": { "path": "src/plugins/saved_objects_management/common/types.ts", - "lineNumber": 45 + "lineNumber": 46 } }, { @@ -1351,7 +1365,7 @@ "description": [], "source": { "path": "src/plugins/saved_objects_management/common/types.ts", - "lineNumber": 46 + "lineNumber": 47 }, "signature": [ { @@ -1371,13 +1385,13 @@ "description": [], "source": { "path": "src/plugins/saved_objects_management/common/types.ts", - "lineNumber": 47 + "lineNumber": 48 } } ], "source": { "path": "src/plugins/saved_objects_management/common/types.ts", - "lineNumber": 43 + "lineNumber": 44 }, "initialIsOpen": false }, @@ -1459,6 +1473,20 @@ "signature": [ "\"multiple\" | \"single\" | \"multiple-isolated\" | \"agnostic\" | undefined" ] + }, + { + "tags": [], + "id": "def-common.SavedObjectMetadata.hiddenType", + "type": "CompoundType", + "label": "hiddenType", + "description": [], + "source": { + "path": "src/plugins/saved_objects_management/common/types.ts", + "lineNumber": 22 + }, + "signature": [ + "boolean | undefined" + ] } ], "source": { @@ -1484,7 +1512,7 @@ "description": [], "source": { "path": "src/plugins/saved_objects_management/common/types.ts", - "lineNumber": 37 + "lineNumber": 38 } }, { @@ -1495,7 +1523,7 @@ "description": [], "source": { "path": "src/plugins/saved_objects_management/common/types.ts", - "lineNumber": 38 + "lineNumber": 39 } }, { @@ -1506,7 +1534,7 @@ "description": [], "source": { "path": "src/plugins/saved_objects_management/common/types.ts", - "lineNumber": 39 + "lineNumber": 40 }, "signature": [ { @@ -1526,7 +1554,7 @@ "description": [], "source": { "path": "src/plugins/saved_objects_management/common/types.ts", - "lineNumber": 40 + "lineNumber": 41 }, "signature": [ { @@ -1541,7 +1569,7 @@ ], "source": { "path": "src/plugins/saved_objects_management/common/types.ts", - "lineNumber": 36 + "lineNumber": 37 }, "initialIsOpen": false } @@ -1556,7 +1584,7 @@ "description": [], "source": { "path": "src/plugins/saved_objects_management/common/types.ts", - "lineNumber": 31 + "lineNumber": 32 }, "signature": [ "\"parent\" | \"child\"" @@ -1573,7 +1601,7 @@ ], "source": { "path": "src/plugins/saved_objects_management/common/types.ts", - "lineNumber": 27 + "lineNumber": 28 }, "signature": [ "SavedObject & { meta: SavedObjectMetadata; }" diff --git a/api_docs/security.json b/api_docs/security.json index 7b29bb75e0873..c839a480dfc69 100644 --- a/api_docs/security.json +++ b/api_docs/security.json @@ -449,7 +449,7 @@ "description": [], "source": { "path": "x-pack/plugins/security/public/plugin.tsx", - "lineNumber": 168 + "lineNumber": 171 }, "signature": [ "{ authc: AuthenticationServiceSetup; sessionTimeout: ISessionTimeout; license: Readonly<{ isLicenseAvailable: () => boolean; isEnabled: () => boolean; getType: () => \"basic\" | \"standard\" | \"gold\" | \"platinum\" | \"enterprise\" | \"trial\" | undefined; getFeatures: () => ", @@ -471,12 +471,12 @@ "description": [], "source": { "path": "x-pack/plugins/security/public/plugin.tsx", - "lineNumber": 169 + "lineNumber": 172 }, "signature": [ "{ navControlService: ", "SecurityNavControlServiceStart", - "; }" + "; authc: AuthenticationServiceSetup; }" ], "lifecycle": "start", "initialIsOpen": true @@ -490,8 +490,19 @@ "id": "def-server.AuditEvent", "type": "Interface", "label": "AuditEvent", + "signature": [ + { + "pluginId": "security", + "scope": "server", + "docId": "kibSecurityPluginApi", + "section": "def-server.AuditEvent", + "text": "AuditEvent" + }, + " extends ", + "LogMeta" + ], "description": [ - "\nAudit event schema using ECS format: https://www.elastic.co/guide/en/ecs/1.6/index.html\n\nIf you add additional fields to the schema ensure you update the Kibana Filebeat module:\nhttps://github.com/elastic/beats/tree/master/filebeat/module/kibana\n" + "\nAudit event schema using ECS format: https://www.elastic.co/guide/en/ecs/1.9/index.html\n\nIf you add additional fields to the schema ensure you update the Kibana Filebeat module:\nhttps://github.com/elastic/beats/tree/master/filebeat/module/kibana\n" ], "tags": [ "public" @@ -502,65 +513,11 @@ "id": "def-server.AuditEvent.message", "type": "string", "label": "message", - "description": [ - "\nHuman readable message describing action, outcome and user.\n" - ], - "source": { - "path": "x-pack/plugins/security/server/audit/audit_events.ts", - "lineNumber": 27 - } - }, - { - "tags": [], - "id": "def-server.AuditEvent.event", - "type": "Object", - "label": "event", - "description": [], - "source": { - "path": "x-pack/plugins/security/server/audit/audit_events.ts", - "lineNumber": 28 - }, - "signature": [ - "{ action: string; category?: ", - { - "pluginId": "security", - "scope": "server", - "docId": "kibSecurityPluginApi", - "section": "def-server.EventCategory", - "text": "EventCategory" - }, - " | undefined; type?: ", - { - "pluginId": "security", - "scope": "server", - "docId": "kibSecurityPluginApi", - "section": "def-server.EventType", - "text": "EventType" - }, - " | undefined; outcome?: ", - { - "pluginId": "security", - "scope": "server", - "docId": "kibSecurityPluginApi", - "section": "def-server.EventOutcome", - "text": "EventOutcome" - }, - " | undefined; }" - ] - }, - { - "tags": [], - "id": "def-server.AuditEvent.user", - "type": "Object", - "label": "user", "description": [], "source": { "path": "x-pack/plugins/security/server/audit/audit_events.ts", - "lineNumber": 34 - }, - "signature": [ - "{ name: string; roles?: readonly string[] | undefined; } | undefined" - ] + "lineNumber": 21 + } }, { "tags": [], @@ -570,53 +527,11 @@ "description": [], "source": { "path": "x-pack/plugins/security/server/audit/audit_events.ts", - "lineNumber": 38 + "lineNumber": 22 }, "signature": [ "{ space_id?: string | undefined; session_id?: string | undefined; saved_object?: { type: string; id: string; } | undefined; authentication_provider?: string | undefined; authentication_type?: string | undefined; authentication_realm?: string | undefined; lookup_realm?: string | undefined; add_to_spaces?: readonly string[] | undefined; delete_from_spaces?: readonly string[] | undefined; } | undefined" ] - }, - { - "tags": [], - "id": "def-server.AuditEvent.error", - "type": "Object", - "label": "error", - "description": [], - "source": { - "path": "x-pack/plugins/security/server/audit/audit_events.ts", - "lineNumber": 80 - }, - "signature": [ - "{ code?: string | undefined; message?: string | undefined; } | undefined" - ] - }, - { - "tags": [], - "id": "def-server.AuditEvent.http", - "type": "Object", - "label": "http", - "description": [], - "source": { - "path": "x-pack/plugins/security/server/audit/audit_events.ts", - "lineNumber": 84 - }, - "signature": [ - "{ request?: { method?: string | undefined; } | undefined; } | undefined" - ] - }, - { - "tags": [], - "id": "def-server.AuditEvent.url", - "type": "Object", - "label": "url", - "description": [], - "source": { - "path": "x-pack/plugins/security/server/audit/audit_events.ts", - "lineNumber": 89 - }, - "signature": [ - "{ domain?: string | undefined; path?: string | undefined; port?: number | undefined; query?: string | undefined; scheme?: string | undefined; } | undefined" - ] } ], "source": { @@ -1183,45 +1098,26 @@ "initialIsOpen": false } ], - "enums": [ - { - "id": "def-server.EventCategory", - "type": "Enum", - "label": "EventCategory", - "tags": [], - "description": [], - "source": { - "path": "x-pack/plugins/security/server/audit/audit_events.ts", - "lineNumber": 98 - }, - "initialIsOpen": false - }, - { - "id": "def-server.EventOutcome", - "type": "Enum", - "label": "EventOutcome", - "tags": [], - "description": [], - "source": { - "path": "x-pack/plugins/security/server/audit/audit_events.ts", - "lineNumber": 111 - }, - "initialIsOpen": false - }, + "enums": [], + "misc": [ { - "id": "def-server.EventType", - "type": "Enum", - "label": "EventType", "tags": [], - "description": [], + "id": "def-server.ROUTE_TAG_CAN_REDIRECT", + "type": "string", + "label": "ROUTE_TAG_CAN_REDIRECT", + "description": [ + "\nIf the route is marked with this tag Security can safely assume that the calling party that sends\nrequest to this route can handle redirect responses. It's particularly important if we want the\nspecific route to be able to initiate or participate in the authentication handshake that may\ninvolve redirects and will eventually redirect authenticated user to this route." + ], "source": { - "path": "x-pack/plugins/security/server/audit/audit_events.ts", - "lineNumber": 104 + "path": "x-pack/plugins/security/server/routes/tags.ts", + "lineNumber": 21 }, + "signature": [ + "\"security:canRedirect\"" + ], "initialIsOpen": false } ], - "misc": [], "objects": [] }, "common": { diff --git a/api_docs/security.mdx b/api_docs/security.mdx index 72b93abf0fe16..4d2afe42cb151 100644 --- a/api_docs/security.mdx +++ b/api_docs/security.mdx @@ -27,6 +27,6 @@ import securityObj from './security.json'; ### Interfaces -### Enums - +### Consts, variables and types + diff --git a/api_docs/security_solution.json b/api_docs/security_solution.json index 1e932a807d7d6..3b8682803694a 100644 --- a/api_docs/security_solution.json +++ b/api_docs/security_solution.json @@ -33,13 +33,7 @@ "text": "PluginSetup" }, ", ", - { - "pluginId": "securitySolution", - "scope": "public", - "docId": "kibSecuritySolutionPluginApi", - "section": "def-public.PluginStart", - "text": "PluginStart" - }, + "PluginStart", ", ", "SetupPlugins" ], @@ -71,7 +65,7 @@ "description": [], "source": { "path": "x-pack/plugins/security_solution/public/plugin.tsx", - "lineNumber": 79 + "lineNumber": 78 } } ], @@ -79,7 +73,7 @@ "returnComment": [], "source": { "path": "x-pack/plugins/security_solution/public/plugin.tsx", - "lineNumber": 79 + "lineNumber": 78 } }, { @@ -98,13 +92,7 @@ "<", "StartPlugins", ", ", - { - "pluginId": "securitySolution", - "scope": "public", - "docId": "kibSecuritySolutionPluginApi", - "section": "def-public.PluginStart", - "text": "PluginStart" - }, + "PluginStart", ">, plugins: ", "SetupPlugins", ") => ", @@ -134,19 +122,13 @@ "<", "StartPlugins", ", ", - { - "pluginId": "securitySolution", - "scope": "public", - "docId": "kibSecuritySolutionPluginApi", - "section": "def-public.PluginStart", - "text": "PluginStart" - }, + "PluginStart", ">" ], "description": [], "source": { "path": "x-pack/plugins/security_solution/public/plugin.tsx", - "lineNumber": 103 + "lineNumber": 102 } }, { @@ -160,7 +142,7 @@ "description": [], "source": { "path": "x-pack/plugins/security_solution/public/plugin.tsx", - "lineNumber": 103 + "lineNumber": 102 } } ], @@ -168,7 +150,7 @@ "returnComment": [], "source": { "path": "x-pack/plugins/security_solution/public/plugin.tsx", - "lineNumber": 103 + "lineNumber": 102 } }, { @@ -207,7 +189,7 @@ "description": [], "source": { "path": "x-pack/plugins/security_solution/public/plugin.tsx", - "lineNumber": 346 + "lineNumber": 343 } }, { @@ -221,7 +203,7 @@ "description": [], "source": { "path": "x-pack/plugins/security_solution/public/plugin.tsx", - "lineNumber": 346 + "lineNumber": 343 } } ], @@ -229,7 +211,7 @@ "returnComment": [], "source": { "path": "x-pack/plugins/security_solution/public/plugin.tsx", - "lineNumber": 346 + "lineNumber": 343 } }, { @@ -245,13 +227,13 @@ "returnComment": [], "source": { "path": "x-pack/plugins/security_solution/public/plugin.tsx", - "lineNumber": 391 + "lineNumber": 388 } } ], "source": { "path": "x-pack/plugins/security_solution/public/plugin.tsx", - "lineNumber": 75 + "lineNumber": 74 }, "initialIsOpen": false } @@ -276,7 +258,7 @@ "description": [], "source": { "path": "x-pack/plugins/security_solution/public/types.ts", - "lineNumber": 68 + "lineNumber": 70 }, "signature": [ "() => Promise<", @@ -287,24 +269,10 @@ ], "source": { "path": "x-pack/plugins/security_solution/public/types.ts", - "lineNumber": 67 + "lineNumber": 69 }, "lifecycle": "setup", "initialIsOpen": true - }, - "start": { - "id": "def-public.PluginStart", - "type": "Interface", - "label": "PluginStart", - "description": [], - "tags": [], - "children": [], - "source": { - "path": "x-pack/plugins/security_solution/public/types.ts", - "lineNumber": 71 - }, - "lifecycle": "start", - "initialIsOpen": true } }, "server": { @@ -453,7 +421,7 @@ "description": [], "source": { "path": "x-pack/plugins/security_solution/server/plugin.ts", - "lineNumber": 145 + "lineNumber": 146 } } ], @@ -461,7 +429,7 @@ "returnComment": [], "source": { "path": "x-pack/plugins/security_solution/server/plugin.ts", - "lineNumber": 145 + "lineNumber": 146 } }, { @@ -521,7 +489,7 @@ "description": [], "source": { "path": "x-pack/plugins/security_solution/server/plugin.ts", - "lineNumber": 157 + "lineNumber": 158 } }, { @@ -535,7 +503,7 @@ "description": [], "source": { "path": "x-pack/plugins/security_solution/server/plugin.ts", - "lineNumber": 157 + "lineNumber": 158 } } ], @@ -543,7 +511,7 @@ "returnComment": [], "source": { "path": "x-pack/plugins/security_solution/server/plugin.ts", - "lineNumber": 157 + "lineNumber": 158 } }, { @@ -582,7 +550,7 @@ "description": [], "source": { "path": "x-pack/plugins/security_solution/server/plugin.ts", - "lineNumber": 338 + "lineNumber": 341 } }, { @@ -596,7 +564,7 @@ "description": [], "source": { "path": "x-pack/plugins/security_solution/server/plugin.ts", - "lineNumber": 338 + "lineNumber": 341 } } ], @@ -604,7 +572,7 @@ "returnComment": [], "source": { "path": "x-pack/plugins/security_solution/server/plugin.ts", - "lineNumber": 338 + "lineNumber": 341 } }, { @@ -620,13 +588,13 @@ "returnComment": [], "source": { "path": "x-pack/plugins/security_solution/server/plugin.ts", - "lineNumber": 412 + "lineNumber": 415 } } ], "source": { "path": "x-pack/plugins/security_solution/server/plugin.ts", - "lineNumber": 129 + "lineNumber": 130 }, "initialIsOpen": false } @@ -1484,7 +1452,7 @@ "children": [], "source": { "path": "x-pack/plugins/security_solution/server/plugin.ts", - "lineNumber": 105 + "lineNumber": 106 }, "lifecycle": "setup", "initialIsOpen": true @@ -1498,7 +1466,7 @@ "children": [], "source": { "path": "x-pack/plugins/security_solution/server/plugin.ts", - "lineNumber": 108 + "lineNumber": 109 }, "lifecycle": "start", "initialIsOpen": true @@ -1554,7 +1522,7 @@ "description": [], "source": { "path": "x-pack/plugins/security_solution/common/detection_engine/schemas/types/default_array.ts", - "lineNumber": 16 + "lineNumber": 17 } } ], @@ -1575,9 +1543,11 @@ "label": "DefaultArray", "source": { "path": "x-pack/plugins/security_solution/common/detection_engine/schemas/types/default_array.ts", - "lineNumber": 16 + "lineNumber": 17 }, - "tags": [], + "tags": [ + "deprecated" + ], "returnComment": [], "initialIsOpen": false }, @@ -1596,7 +1566,7 @@ "description": [], "source": { "path": "x-pack/plugins/security_solution/common/exact_check.ts", - "lineNumber": 30 + "lineNumber": 31 } }, { @@ -1613,7 +1583,7 @@ "description": [], "source": { "path": "x-pack/plugins/security_solution/common/exact_check.ts", - "lineNumber": 31 + "lineNumber": 32 } } ], @@ -1634,21 +1604,25 @@ "label": "exactCheck", "source": { "path": "x-pack/plugins/security_solution/common/exact_check.ts", - "lineNumber": 29 + "lineNumber": 30 }, - "tags": [], + "tags": [ + "deprecated" + ], "returnComment": [], "initialIsOpen": false }, { - "tags": [], + "tags": [ + "deprecated" + ], "id": "def-common.foldLeftRight", "type": "Function", "label": "foldLeftRight", "description": [], "source": { "path": "x-pack/plugins/security_solution/common/test_utils.ts", - "lineNumber": 29 + "lineNumber": 38 }, "signature": [ "(ma: ", @@ -1674,7 +1648,7 @@ "description": [], "source": { "path": "x-pack/plugins/security_solution/common/format_errors.ts", - "lineNumber": 11 + "lineNumber": 14 } } ], @@ -1687,9 +1661,11 @@ "label": "formatErrors", "source": { "path": "x-pack/plugins/security_solution/common/format_errors.ts", - "lineNumber": 11 + "lineNumber": 14 }, - "tags": [], + "tags": [ + "deprecated" + ], "returnComment": [], "initialIsOpen": false }, @@ -1711,7 +1687,7 @@ "description": [], "source": { "path": "x-pack/plugins/security_solution/common/test_utils.ts", - "lineNumber": 36 + "lineNumber": 46 } } ], @@ -1728,9 +1704,11 @@ "label": "getPaths", "source": { "path": "x-pack/plugins/security_solution/common/test_utils.ts", - "lineNumber": 36 + "lineNumber": 46 }, - "tags": [], + "tags": [ + "deprecated" + ], "returnComment": [], "initialIsOpen": false }, @@ -1749,7 +1727,7 @@ "description": [], "source": { "path": "x-pack/plugins/security_solution/common/test_utils.ts", - "lineNumber": 49 + "lineNumber": 60 } } ], @@ -1762,9 +1740,11 @@ "label": "removeExternalLinkText", "source": { "path": "x-pack/plugins/security_solution/common/test_utils.ts", - "lineNumber": 49 + "lineNumber": 60 }, - "tags": [], + "tags": [ + "deprecated" + ], "returnComment": [], "initialIsOpen": false }, @@ -1914,7 +1894,7 @@ "description": [], "source": { "path": "x-pack/plugins/security_solution/common/detection_engine/schemas/types/default_version_number.ts", - "lineNumber": 24 + "lineNumber": 25 }, "signature": [ "number" @@ -1924,7 +1904,9 @@ ], "objects": [ { - "tags": [], + "tags": [ + "deprecated" + ], "id": "def-common.DefaultStringArray", "type": "Object", "label": "DefaultStringArray", @@ -1933,7 +1915,7 @@ ], "source": { "path": "x-pack/plugins/security_solution/common/detection_engine/schemas/types/default_string_array.ts", - "lineNumber": 16 + "lineNumber": 17 }, "signature": [ "Type", @@ -1942,7 +1924,9 @@ "initialIsOpen": false }, { - "tags": [], + "tags": [ + "deprecated" + ], "id": "def-common.DefaultUuid", "type": "Object", "label": "DefaultUuid", @@ -1951,7 +1935,7 @@ ], "source": { "path": "x-pack/plugins/security_solution/common/detection_engine/schemas/types/default_uuid.ts", - "lineNumber": 19 + "lineNumber": 20 }, "signature": [ "Type", @@ -1960,7 +1944,9 @@ "initialIsOpen": false }, { - "tags": [], + "tags": [ + "deprecated" + ], "id": "def-common.DefaultVersionNumber", "type": "Object", "label": "DefaultVersionNumber", @@ -1969,7 +1955,7 @@ ], "source": { "path": "x-pack/plugins/security_solution/common/detection_engine/schemas/types/default_version_number.ts", - "lineNumber": 16 + "lineNumber": 17 }, "signature": [ "Type", @@ -1978,7 +1964,9 @@ "initialIsOpen": false }, { - "tags": [], + "tags": [ + "deprecated" + ], "id": "def-common.NonEmptyString", "type": "Object", "label": "NonEmptyString", @@ -1987,7 +1975,7 @@ ], "source": { "path": "x-pack/plugins/security_solution/common/detection_engine/schemas/types/non_empty_string.ts", - "lineNumber": 15 + "lineNumber": 16 }, "signature": [ "Type", diff --git a/api_docs/security_solution.mdx b/api_docs/security_solution.mdx index ec64375b5555f..397b2d5238596 100644 --- a/api_docs/security_solution.mdx +++ b/api_docs/security_solution.mdx @@ -16,9 +16,6 @@ import securitySolutionObj from './security_solution.json'; ### Setup -### Start - - ### Classes diff --git a/api_docs/share.json b/api_docs/share.json index f59639d35aba5..393d6dc4790ef 100644 --- a/api_docs/share.json +++ b/api_docs/share.json @@ -490,7 +490,7 @@ }, " extends Pick<", "EuiContextMenuPanelItemDescriptorEntry", - ", \"onClick\" | \"key\" | \"size\" | \"className\" | \"aria-label\" | \"data-test-subj\" | \"disabled\" | \"target\" | \"href\" | \"icon\" | \"rel\" | \"buttonRef\" | \"toolTipContent\" | \"toolTipTitle\" | \"toolTipPosition\" | \"layoutAlign\" | \"panel\">" + ", \"onClick\" | \"key\" | \"size\" | \"className\" | \"aria-label\" | \"disabled\" | \"data-test-subj\" | \"target\" | \"href\" | \"icon\" | \"rel\" | \"buttonRef\" | \"toolTipContent\" | \"toolTipTitle\" | \"toolTipPosition\" | \"layoutAlign\" | \"panel\">" ], "description": [], "tags": [ diff --git a/api_docs/task_manager.json b/api_docs/task_manager.json index 0d12bd269a0ab..526c81877b9d6 100644 --- a/api_docs/task_manager.json +++ b/api_docs/task_manager.json @@ -78,7 +78,7 @@ "description": [], "source": { "path": "x-pack/plugins/task_manager/server/plugin.ts", - "lineNumber": 55 + "lineNumber": 58 } } ], @@ -86,7 +86,7 @@ "returnComment": [], "source": { "path": "x-pack/plugins/task_manager/server/plugin.ts", - "lineNumber": 55 + "lineNumber": 58 } }, { @@ -131,7 +131,7 @@ "description": [], "source": { "path": "x-pack/plugins/task_manager/server/plugin.ts", - "lineNumber": 62 + "lineNumber": 65 } } ], @@ -139,7 +139,7 @@ "returnComment": [], "source": { "path": "x-pack/plugins/task_manager/server/plugin.ts", - "lineNumber": 62 + "lineNumber": 65 } }, { @@ -183,7 +183,7 @@ "description": [], "source": { "path": "x-pack/plugins/task_manager/server/plugin.ts", - "lineNumber": 109 + "lineNumber": 113 } } ], @@ -191,18 +191,50 @@ "returnComment": [], "source": { "path": "x-pack/plugins/task_manager/server/plugin.ts", - "lineNumber": 109 + "lineNumber": 113 } } ], "source": { "path": "x-pack/plugins/task_manager/server/plugin.ts", - "lineNumber": 44 + "lineNumber": 47 }, "initialIsOpen": false } ], "functions": [ + { + "id": "def-server.asInterval", + "type": "Function", + "label": "asInterval", + "signature": [ + "(ms: number) => string" + ], + "description": [], + "children": [ + { + "id": "def-server.asInterval.$1", + "type": "number", + "label": "ms", + "isRequired": true, + "signature": [ + "number" + ], + "description": [], + "source": { + "path": "x-pack/plugins/task_manager/server/lib/intervals.ts", + "lineNumber": 41 + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "x-pack/plugins/task_manager/server/lib/intervals.ts", + "lineNumber": 41 + }, + "initialIsOpen": false + }, { "id": "def-server.isUnrecoverableError", "type": "Function", @@ -760,7 +792,7 @@ "lineNumber": 31 }, "signature": [ - "{ addMiddleware: (middleware: Middleware) => void; } & Pick" + "{ index: string; addMiddleware: (middleware: Middleware) => void; } & Pick" ], "lifecycle": "setup", "initialIsOpen": true @@ -773,7 +805,7 @@ "description": [], "source": { "path": "x-pack/plugins/task_manager/server/plugin.ts", - "lineNumber": 36 + "lineNumber": 39 }, "signature": [ "Pick & Pick & { removeIfExists: TaskStore['remove']; }" diff --git a/api_docs/telemetry_collection_manager.json b/api_docs/telemetry_collection_manager.json index 1bd65a82cffdb..b682fac872320 100644 --- a/api_docs/telemetry_collection_manager.json +++ b/api_docs/telemetry_collection_manager.json @@ -55,9 +55,13 @@ "lineNumber": 57 }, "signature": [ - "Pick<", - "CollectorSet", - ", \"makeStatsCollector\" | \"makeUsageCollector\" | \"registerCollector\" | \"getCollectorByType\" | \"areAllCollectorsReady\" | \"bulkFetch\" | \"bulkFetchUsage\" | \"toObject\" | \"toApiFieldNames\">" + { + "pluginId": "usageCollection", + "scope": "server", + "docId": "kibUsageCollectionPluginApi", + "section": "def-server.UsageCollectionSetup", + "text": "UsageCollectionSetup" + } ] }, { @@ -364,15 +368,9 @@ "lineNumber": 23 }, "signature": [ - "(config: ", - { - "pluginId": "telemetryCollectionManager", - "scope": "server", - "docId": "kibTelemetryCollectionManagerPluginApi", - "section": "def-server.StatsGetterConfig", - "text": "StatsGetterConfig" - }, - ") => Promise" + "[]>; (config: ", + "EncryptedStatsGetterConfig", + "): Promise; }" ] }, { @@ -445,15 +445,9 @@ "lineNumber": 29 }, "signature": [ - "(config: ", - { - "pluginId": "telemetryCollectionManager", - "scope": "server", - "docId": "kibTelemetryCollectionManagerPluginApi", - "section": "def-server.StatsGetterConfig", - "text": "StatsGetterConfig" - }, - ") => Promise" + "[]>; (config: ", + "EncryptedStatsGetterConfig", + "): Promise; }" ] }, { diff --git a/api_docs/telemetry_management_section.json b/api_docs/telemetry_management_section.json index a238370bd0239..ec9112f9bc72c 100644 --- a/api_docs/telemetry_management_section.json +++ b/api_docs/telemetry_management_section.json @@ -194,7 +194,7 @@ "description": [], "source": { "path": "src/plugins/telemetry_management_section/public/plugin.tsx", - "lineNumber": 35 + "lineNumber": 38 }, "signature": [ "(enabled: boolean) => void" @@ -203,7 +203,7 @@ ], "source": { "path": "src/plugins/telemetry_management_section/public/plugin.tsx", - "lineNumber": 34 + "lineNumber": 37 }, "lifecycle": "setup", "initialIsOpen": true diff --git a/api_docs/timelines.json b/api_docs/timelines.json index 309db2a963f71..17f0fb4706586 100644 --- a/api_docs/timelines.json +++ b/api_docs/timelines.json @@ -22,7 +22,7 @@ "description": [], "source": { "path": "x-pack/plugins/timelines/public/types.ts", - "lineNumber": 4 + "lineNumber": 11 }, "signature": [ "((props: ", @@ -35,7 +35,7 @@ ], "source": { "path": "x-pack/plugins/timelines/public/types.ts", - "lineNumber": 3 + "lineNumber": 10 }, "lifecycle": "setup", "initialIsOpen": true @@ -57,7 +57,7 @@ "children": [], "source": { "path": "x-pack/plugins/timelines/server/types.ts", - "lineNumber": 2 + "lineNumber": 9 }, "lifecycle": "setup", "initialIsOpen": true @@ -71,7 +71,7 @@ "children": [], "source": { "path": "x-pack/plugins/timelines/server/types.ts", - "lineNumber": 4 + "lineNumber": 11 }, "lifecycle": "start", "initialIsOpen": true @@ -91,7 +91,7 @@ "description": [], "source": { "path": "x-pack/plugins/timelines/common/index.ts", - "lineNumber": 1 + "lineNumber": 8 }, "signature": [ "\"timelines\"" @@ -106,7 +106,7 @@ "description": [], "source": { "path": "x-pack/plugins/timelines/common/index.ts", - "lineNumber": 2 + "lineNumber": 9 }, "signature": [ "\"timelines\"" diff --git a/api_docs/triggers_actions_ui.json b/api_docs/triggers_actions_ui.json index 0b52bf674c1d5..04a7a396c4b28 100644 --- a/api_docs/triggers_actions_ui.json +++ b/api_docs/triggers_actions_ui.json @@ -1085,7 +1085,7 @@ "description": [], "source": { "path": "x-pack/plugins/triggers_actions_ui/public/types.ts", - "lineNumber": 234 + "lineNumber": 235 } }, { @@ -1096,7 +1096,7 @@ "description": [], "source": { "path": "x-pack/plugins/triggers_actions_ui/public/types.ts", - "lineNumber": 235 + "lineNumber": 236 } }, { @@ -1107,7 +1107,7 @@ "description": [], "source": { "path": "x-pack/plugins/triggers_actions_ui/public/types.ts", - "lineNumber": 236 + "lineNumber": 237 } }, { @@ -1118,7 +1118,7 @@ "description": [], "source": { "path": "x-pack/plugins/triggers_actions_ui/public/types.ts", - "lineNumber": 237 + "lineNumber": 238 }, "signature": [ "string | ((docLinks: ", @@ -1140,7 +1140,7 @@ "description": [], "source": { "path": "x-pack/plugins/triggers_actions_ui/public/types.ts", - "lineNumber": 238 + "lineNumber": 239 }, "signature": [ "(alertParams: Params) => ", @@ -1161,7 +1161,7 @@ "description": [], "source": { "path": "x-pack/plugins/triggers_actions_ui/public/types.ts", - "lineNumber": 239 + "lineNumber": 240 }, "signature": [ "React.FunctionComponent | React.LazyExoticComponent(property: Key, value: Params[Key] | undefined) => void" @@ -1296,7 +1296,7 @@ "description": [], "source": { "path": "x-pack/plugins/triggers_actions_ui/public/types.ts", - "lineNumber": 221 + "lineNumber": 222 }, "signature": [ "(key: Prop, value: Pick<", @@ -1318,7 +1318,7 @@ "description": [], "source": { "path": "x-pack/plugins/triggers_actions_ui/public/types.ts", - "lineNumber": 225 + "lineNumber": 226 }, "signature": [ { @@ -1338,7 +1338,7 @@ "description": [], "source": { "path": "x-pack/plugins/triggers_actions_ui/public/types.ts", - "lineNumber": 226 + "lineNumber": 227 } }, { @@ -1349,7 +1349,7 @@ "description": [], "source": { "path": "x-pack/plugins/triggers_actions_ui/public/types.ts", - "lineNumber": 227 + "lineNumber": 228 }, "signature": [ { @@ -1370,7 +1370,7 @@ "description": [], "source": { "path": "x-pack/plugins/triggers_actions_ui/public/types.ts", - "lineNumber": 228 + "lineNumber": 229 }, "signature": [ "MetaData | undefined" @@ -1384,7 +1384,7 @@ "description": [], "source": { "path": "x-pack/plugins/triggers_actions_ui/public/types.ts", - "lineNumber": 229 + "lineNumber": 230 }, "signature": [ { @@ -1404,7 +1404,7 @@ "description": [], "source": { "path": "x-pack/plugins/triggers_actions_ui/public/types.ts", - "lineNumber": 230 + "lineNumber": 231 }, "signature": [ { @@ -1419,7 +1419,7 @@ ], "source": { "path": "x-pack/plugins/triggers_actions_ui/public/types.ts", - "lineNumber": 211 + "lineNumber": 212 }, "initialIsOpen": false }, @@ -1546,7 +1546,7 @@ "description": [], "source": { "path": "x-pack/plugins/triggers_actions_ui/public/types.ts", - "lineNumber": 247 + "lineNumber": 248 }, "signature": [ "any" @@ -1555,7 +1555,7 @@ ], "source": { "path": "x-pack/plugins/triggers_actions_ui/public/types.ts", - "lineNumber": 246 + "lineNumber": 247 }, "initialIsOpen": false }, @@ -1934,7 +1934,7 @@ "description": [], "source": { "path": "x-pack/plugins/triggers_actions_ui/public/types.ts", - "lineNumber": 160 + "lineNumber": 161 }, "signature": [ "PreConfiguredActionConnector", @@ -1997,7 +1997,7 @@ "description": [], "source": { "path": "x-pack/plugins/triggers_actions_ui/public/types.ts", - "lineNumber": 178 + "lineNumber": 179 }, "signature": [ "AsActionVariables<\"params\" | \"state\"> & Partial>" diff --git a/api_docs/ui_actions.json b/api_docs/ui_actions.json index bf6caf81ca07f..a29bf632fe3c6 100644 --- a/api_docs/ui_actions.json +++ b/api_docs/ui_actions.json @@ -1616,7 +1616,7 @@ "type": "Function", "label": "getDisplayNameTooltip", "signature": [ - "(context: Context) => string" + "((context: Context) => string) | undefined" ], "description": [ "\nReturns tooltip text which should be displayed when user hovers this object.\nShould return empty string if tooltip should not be displayed." diff --git a/api_docs/ui_actions_enhanced.json b/api_docs/ui_actions_enhanced.json index 5f4f76e574b8e..6923e3bc32af8 100644 --- a/api_docs/ui_actions_enhanced.json +++ b/api_docs/ui_actions_enhanced.json @@ -266,7 +266,7 @@ "section": "def-public.Presentable", "text": "Presentable" }, - ", \"id\" | \"getDisplayName\" | \"order\" | \"MenuItem\" | \"getIconType\" | \"getDisplayNameTooltip\" | \"isCompatible\" | \"grouping\">,", + ", \"id\" | \"getDisplayName\" | \"grouping\" | \"getIconType\" | \"order\" | \"MenuItem\" | \"getDisplayNameTooltip\" | \"isCompatible\">,", { "pluginId": "kibanaUtils", "scope": "public", @@ -1629,7 +1629,7 @@ ], "source": { "path": "x-pack/plugins/ui_actions_enhanced/public/dynamic_actions/dynamic_action_manager.ts", - "lineNumber": 246 + "lineNumber": 251 } }, { @@ -1660,7 +1660,7 @@ ], "source": { "path": "x-pack/plugins/ui_actions_enhanced/public/dynamic_actions/dynamic_action_manager.ts", - "lineNumber": 246 + "lineNumber": 251 } }, { @@ -1676,7 +1676,7 @@ ], "source": { "path": "x-pack/plugins/ui_actions_enhanced/public/dynamic_actions/dynamic_action_manager.ts", - "lineNumber": 246 + "lineNumber": 251 } } ], @@ -1684,7 +1684,7 @@ "returnComment": [], "source": { "path": "x-pack/plugins/ui_actions_enhanced/public/dynamic_actions/dynamic_action_manager.ts", - "lineNumber": 246 + "lineNumber": 251 } }, { @@ -1711,7 +1711,7 @@ ], "source": { "path": "x-pack/plugins/ui_actions_enhanced/public/dynamic_actions/dynamic_action_manager.ts", - "lineNumber": 277 + "lineNumber": 282 } } ], @@ -1719,7 +1719,7 @@ "returnComment": [], "source": { "path": "x-pack/plugins/ui_actions_enhanced/public/dynamic_actions/dynamic_action_manager.ts", - "lineNumber": 277 + "lineNumber": 282 } }, { @@ -1746,7 +1746,7 @@ ], "source": { "path": "x-pack/plugins/ui_actions_enhanced/public/dynamic_actions/dynamic_action_manager.ts", - "lineNumber": 297 + "lineNumber": 302 } } ], @@ -1754,7 +1754,7 @@ "returnComment": [], "source": { "path": "x-pack/plugins/ui_actions_enhanced/public/dynamic_actions/dynamic_action_manager.ts", - "lineNumber": 297 + "lineNumber": 302 } } ], @@ -2031,7 +2031,7 @@ "section": "def-public.BaseActionFactoryContext", "text": "BaseActionFactoryContext" }, - ">>) => JSX.Element" + ">>) => JSX.Element | null" ], "description": [], "label": "ActionWizard", @@ -2293,7 +2293,7 @@ "section": "def-public.Presentable", "text": "Presentable" }, - ", \"id\" | \"getDisplayName\" | \"order\" | \"MenuItem\" | \"getIconType\" | \"getDisplayNameTooltip\" | \"isCompatible\" | \"grouping\">>,", + ", \"id\" | \"getDisplayName\" | \"grouping\" | \"getIconType\" | \"order\" | \"MenuItem\" | \"getDisplayNameTooltip\" | \"isCompatible\">>,", { "pluginId": "kibanaUtils", "scope": "public", @@ -2919,6 +2919,122 @@ }, "initialIsOpen": false }, + { + "id": "def-public.DrilldownTemplate", + "type": "Interface", + "label": "DrilldownTemplate", + "description": [ + "\nTemplate for a pre-configured new drilldown, this gives ability to create a\ndrilldown from a template instead of user creating a drilldown from scratch.\nThis is used in \"drilldown cloning\" functionality, where drilldowns can be\ncloned from one dashboard panel to another." + ], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-public.DrilldownTemplate.id", + "type": "string", + "label": "id", + "description": [ + "\nAny string that uniquely identifies this item in a list of `DrilldownTemplate[]`." + ], + "source": { + "path": "x-pack/plugins/ui_actions_enhanced/public/drilldowns/drilldown_manager/types.ts", + "lineNumber": 93 + } + }, + { + "tags": [], + "id": "def-public.DrilldownTemplate.icon", + "type": "string", + "label": "icon", + "description": [ + "\nEUI icon display next to the description." + ], + "source": { + "path": "x-pack/plugins/ui_actions_enhanced/public/drilldowns/drilldown_manager/types.ts", + "lineNumber": 98 + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [], + "id": "def-public.DrilldownTemplate.description", + "type": "string", + "label": "description", + "description": [ + "\nA user facing text that provides information about the source of this template." + ], + "source": { + "path": "x-pack/plugins/ui_actions_enhanced/public/drilldowns/drilldown_manager/types.ts", + "lineNumber": 103 + } + }, + { + "tags": [], + "id": "def-public.DrilldownTemplate.factoryId", + "type": "string", + "label": "factoryId", + "description": [ + "\nDrilldown type, dynamic action factory ID." + ], + "source": { + "path": "x-pack/plugins/ui_actions_enhanced/public/drilldowns/drilldown_manager/types.ts", + "lineNumber": 108 + } + }, + { + "tags": [], + "id": "def-public.DrilldownTemplate.name", + "type": "string", + "label": "name", + "description": [ + "\nSuggested new name of the cloned drilldown. If a drilldown with such suggested\nname already exists at current place, a suffix like \" (copy 1)\" will be added." + ], + "source": { + "path": "x-pack/plugins/ui_actions_enhanced/public/drilldowns/drilldown_manager/types.ts", + "lineNumber": 114 + } + }, + { + "tags": [], + "id": "def-public.DrilldownTemplate.triggers", + "type": "Array", + "label": "triggers", + "description": [ + "\nPre-selected triggers." + ], + "source": { + "path": "x-pack/plugins/ui_actions_enhanced/public/drilldowns/drilldown_manager/types.ts", + "lineNumber": 119 + }, + "signature": [ + "string[]" + ] + }, + { + "tags": [], + "id": "def-public.DrilldownTemplate.config", + "type": "Unknown", + "label": "config", + "description": [ + "\nPreliminary configuration of the new drilldown, to be used in the dynamicaction factory." + ], + "source": { + "path": "x-pack/plugins/ui_actions_enhanced/public/drilldowns/drilldown_manager/types.ts", + "lineNumber": 124 + }, + "signature": [ + "unknown" + ] + } + ], + "source": { + "path": "x-pack/plugins/ui_actions_enhanced/public/drilldowns/drilldown_manager/types.ts", + "lineNumber": 89 + }, + "initialIsOpen": false + }, { "id": "def-public.DynamicActionManagerParams", "type": "Interface", @@ -3252,24 +3368,18 @@ "children": [ { "tags": [], - "id": "def-public.StartContract.FlyoutManageDrilldowns", + "id": "def-public.StartContract.DrilldownManager", "type": "Function", - "label": "FlyoutManageDrilldowns", + "label": "DrilldownManager", "description": [], "source": { "path": "x-pack/plugins/ui_actions_enhanced/public/plugin.ts", "lineNumber": 60 }, "signature": [ - "React.FC>" + "React.FC<", + "PublicDrilldownManagerProps", + ">" ] } ], diff --git a/api_docs/vis_type_timeseries.json b/api_docs/vis_type_timeseries.json index a3c2c605c8de9..6f5abcdc6e3c2 100644 --- a/api_docs/vis_type_timeseries.json +++ b/api_docs/vis_type_timeseries.json @@ -26,7 +26,7 @@ "description": [], "source": { "path": "src/plugins/vis_type_timeseries/common/types.ts", - "lineNumber": 74 + "lineNumber": 76 } } ], @@ -40,7 +40,7 @@ "label": "isVisSeriesData", "source": { "path": "src/plugins/vis_type_timeseries/common/types.ts", - "lineNumber": 74 + "lineNumber": 76 }, "tags": [], "returnComment": [], @@ -61,7 +61,7 @@ "description": [], "source": { "path": "src/plugins/vis_type_timeseries/common/types.ts", - "lineNumber": 71 + "lineNumber": 73 } } ], @@ -74,7 +74,7 @@ "label": "isVisTableData", "source": { "path": "src/plugins/vis_type_timeseries/common/types.ts", - "lineNumber": 71 + "lineNumber": 73 }, "tags": [], "returnComment": [], diff --git a/api_docs/visualizations.json b/api_docs/visualizations.json index 0635d17107efa..9132b58efe340 100644 --- a/api_docs/visualizations.json +++ b/api_docs/visualizations.json @@ -2,6 +2,439 @@ "id": "visualizations", "client": { "classes": [ + { + "id": "def-public.BaseVisType", + "type": "Class", + "tags": [], + "label": "BaseVisType", + "description": [], + "signature": [ + { + "pluginId": "visualizations", + "scope": "public", + "docId": "kibVisualizationsPluginApi", + "section": "def-public.BaseVisType", + "text": "BaseVisType" + }, + "" + ], + "children": [ + { + "tags": [], + "id": "def-public.BaseVisType.name", + "type": "string", + "label": "name", + "description": [], + "source": { + "path": "src/plugins/visualizations/public/vis_types/base_vis_type.ts", + "lineNumber": 25 + } + }, + { + "tags": [], + "id": "def-public.BaseVisType.title", + "type": "string", + "label": "title", + "description": [], + "source": { + "path": "src/plugins/visualizations/public/vis_types/base_vis_type.ts", + "lineNumber": 26 + } + }, + { + "tags": [], + "id": "def-public.BaseVisType.description", + "type": "string", + "label": "description", + "description": [], + "source": { + "path": "src/plugins/visualizations/public/vis_types/base_vis_type.ts", + "lineNumber": 27 + } + }, + { + "tags": [], + "id": "def-public.BaseVisType.note", + "type": "string", + "label": "note", + "description": [], + "source": { + "path": "src/plugins/visualizations/public/vis_types/base_vis_type.ts", + "lineNumber": 28 + } + }, + { + "tags": [], + "id": "def-public.BaseVisType.getSupportedTriggers", + "type": "Function", + "label": "getSupportedTriggers", + "description": [], + "source": { + "path": "src/plugins/visualizations/public/vis_types/base_vis_type.ts", + "lineNumber": 29 + }, + "signature": [ + "(() => string[]) | undefined" + ] + }, + { + "tags": [], + "id": "def-public.BaseVisType.icon", + "type": "CompoundType", + "label": "icon", + "description": [], + "source": { + "path": "src/plugins/visualizations/public/vis_types/base_vis_type.ts", + "lineNumber": 30 + }, + "signature": [ + "string | React.ComponentClass<{}, any> | React.FunctionComponent<{}> | undefined" + ] + }, + { + "tags": [], + "id": "def-public.BaseVisType.image", + "type": "string", + "label": "image", + "description": [], + "source": { + "path": "src/plugins/visualizations/public/vis_types/base_vis_type.ts", + "lineNumber": 31 + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [], + "id": "def-public.BaseVisType.stage", + "type": "CompoundType", + "label": "stage", + "description": [], + "source": { + "path": "src/plugins/visualizations/public/vis_types/base_vis_type.ts", + "lineNumber": 32 + }, + "signature": [ + "\"experimental\" | \"beta\" | \"production\"" + ] + }, + { + "tags": [], + "id": "def-public.BaseVisType.group", + "type": "Enum", + "label": "group", + "description": [], + "source": { + "path": "src/plugins/visualizations/public/vis_types/base_vis_type.ts", + "lineNumber": 33 + }, + "signature": [ + { + "pluginId": "visualizations", + "scope": "public", + "docId": "kibVisualizationsPluginApi", + "section": "def-public.VisGroups", + "text": "VisGroups" + } + ] + }, + { + "tags": [], + "id": "def-public.BaseVisType.titleInWizard", + "type": "string", + "label": "titleInWizard", + "description": [], + "source": { + "path": "src/plugins/visualizations/public/vis_types/base_vis_type.ts", + "lineNumber": 34 + } + }, + { + "tags": [], + "id": "def-public.BaseVisType.options", + "type": "Object", + "label": "options", + "description": [], + "source": { + "path": "src/plugins/visualizations/public/vis_types/base_vis_type.ts", + "lineNumber": 35 + }, + "signature": [ + "VisTypeOptions" + ] + }, + { + "tags": [], + "id": "def-public.BaseVisType.visConfig", + "type": "Any", + "label": "visConfig", + "description": [], + "source": { + "path": "src/plugins/visualizations/public/vis_types/base_vis_type.ts", + "lineNumber": 36 + }, + "signature": [ + "any" + ] + }, + { + "tags": [], + "id": "def-public.BaseVisType.editorConfig", + "type": "Any", + "label": "editorConfig", + "description": [], + "source": { + "path": "src/plugins/visualizations/public/vis_types/base_vis_type.ts", + "lineNumber": 37 + }, + "signature": [ + "any" + ] + }, + { + "tags": [], + "id": "def-public.BaseVisType.hidden", + "type": "boolean", + "label": "hidden", + "description": [], + "source": { + "path": "src/plugins/visualizations/public/vis_types/base_vis_type.ts", + "lineNumber": 38 + } + }, + { + "tags": [], + "id": "def-public.BaseVisType.requiresSearch", + "type": "boolean", + "label": "requiresSearch", + "description": [], + "source": { + "path": "src/plugins/visualizations/public/vis_types/base_vis_type.ts", + "lineNumber": 39 + } + }, + { + "tags": [], + "id": "def-public.BaseVisType.hierarchicalData", + "type": "CompoundType", + "label": "hierarchicalData", + "description": [], + "source": { + "path": "src/plugins/visualizations/public/vis_types/base_vis_type.ts", + "lineNumber": 40 + }, + "signature": [ + "boolean | ((vis: { params: TVisParams; }) => boolean)" + ] + }, + { + "tags": [], + "id": "def-public.BaseVisType.setup", + "type": "Function", + "label": "setup", + "description": [], + "source": { + "path": "src/plugins/visualizations/public/vis_types/base_vis_type.ts", + "lineNumber": 41 + }, + "signature": [ + "((vis: ", + { + "pluginId": "visualizations", + "scope": "public", + "docId": "kibVisualizationsPluginApi", + "section": "def-public.Vis", + "text": "Vis" + }, + ") => Promise<", + { + "pluginId": "visualizations", + "scope": "public", + "docId": "kibVisualizationsPluginApi", + "section": "def-public.Vis", + "text": "Vis" + }, + ">) | undefined" + ] + }, + { + "tags": [], + "id": "def-public.BaseVisType.getUsedIndexPattern", + "type": "Function", + "label": "getUsedIndexPattern", + "description": [], + "source": { + "path": "src/plugins/visualizations/public/vis_types/base_vis_type.ts", + "lineNumber": 42 + }, + "signature": [ + "((visParams: ", + { + "pluginId": "visualizations", + "scope": "common", + "docId": "kibVisualizationsPluginApi", + "section": "def-common.VisParams", + "text": "VisParams" + }, + ") => ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IndexPattern", + "text": "IndexPattern" + }, + "[] | Promise<", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IndexPattern", + "text": "IndexPattern" + }, + "[]>) | undefined" + ] + }, + { + "tags": [], + "id": "def-public.BaseVisType.inspectorAdapters", + "type": "CompoundType", + "label": "inspectorAdapters", + "description": [], + "source": { + "path": "src/plugins/visualizations/public/vis_types/base_vis_type.ts", + "lineNumber": 43 + }, + "signature": [ + { + "pluginId": "inspector", + "scope": "common", + "docId": "kibInspectorPluginApi", + "section": "def-common.Adapters", + "text": "Adapters" + }, + " | (() => ", + { + "pluginId": "inspector", + "scope": "common", + "docId": "kibInspectorPluginApi", + "section": "def-common.Adapters", + "text": "Adapters" + }, + ") | undefined" + ] + }, + { + "tags": [], + "id": "def-public.BaseVisType.toExpressionAst", + "type": "Function", + "label": "toExpressionAst", + "description": [], + "source": { + "path": "src/plugins/visualizations/public/vis_types/base_vis_type.ts", + "lineNumber": 44 + }, + "signature": [ + { + "pluginId": "visualizations", + "scope": "public", + "docId": "kibVisualizationsPluginApi", + "section": "def-public.VisToExpressionAst", + "text": "VisToExpressionAst" + }, + "" + ] + }, + { + "tags": [], + "id": "def-public.BaseVisType.getInfoMessage", + "type": "Function", + "label": "getInfoMessage", + "description": [], + "source": { + "path": "src/plugins/visualizations/public/vis_types/base_vis_type.ts", + "lineNumber": 45 + }, + "signature": [ + "((vis: ", + { + "pluginId": "visualizations", + "scope": "public", + "docId": "kibVisualizationsPluginApi", + "section": "def-public.Vis", + "text": "Vis" + }, + "<", + { + "pluginId": "visualizations", + "scope": "common", + "docId": "kibVisualizationsPluginApi", + "section": "def-common.VisParams", + "text": "VisParams" + }, + ">) => React.ReactNode) | undefined" + ] + }, + { + "tags": [], + "id": "def-public.BaseVisType.schemas", + "type": "Object", + "label": "schemas", + "description": [], + "source": { + "path": "src/plugins/visualizations/public/vis_types/base_vis_type.ts", + "lineNumber": 46 + }, + "signature": [ + "Schemas" + ] + }, + { + "id": "def-public.BaseVisType.Unnamed", + "type": "Function", + "label": "Constructor", + "signature": [ + "any" + ], + "description": [], + "children": [ + { + "id": "def-public.BaseVisType.Unnamed.$1", + "type": "Object", + "label": "opts", + "isRequired": true, + "signature": [ + { + "pluginId": "visualizations", + "scope": "public", + "docId": "kibVisualizationsPluginApi", + "section": "def-public.VisTypeDefinition", + "text": "VisTypeDefinition" + }, + "" + ], + "description": [], + "source": { + "path": "src/plugins/visualizations/public/vis_types/base_vis_type.ts", + "lineNumber": 48 + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/visualizations/public/vis_types/base_vis_type.ts", + "lineNumber": 48 + } + } + ], + "source": { + "path": "src/plugins/visualizations/public/vis_types/base_vis_type.ts", + "lineNumber": 24 + }, + "initialIsOpen": false + }, { "id": "def-public.PersistedState", "type": "Class", @@ -361,7 +794,13 @@ "lineNumber": 74 }, "signature": [ - "BaseVisType", + { + "pluginId": "visualizations", + "scope": "public", + "docId": "kibVisualizationsPluginApi", + "section": "def-public.BaseVisType", + "text": "BaseVisType" + }, "" ] }, @@ -806,7 +1245,7 @@ { "id": "def-public.VisualizationContainer.$1", "type": "Object", - "label": "{\n 'data-test-subj': dataTestSubj = '',\n className,\n children,\n handlers,\n showNoResult = false,\n}", + "label": "{\n 'data-test-subj': dataTestSubj = '',\n className,\n children,\n handlers,\n showNoResult = false,\n error,\n}", "isRequired": true, "signature": [ "VisualizationContainerProps" @@ -814,18 +1253,20 @@ "description": [], "source": { "path": "src/plugins/visualizations/public/components/visualization_container.tsx", - "lineNumber": 23 + "lineNumber": 27 } } ], "signature": [ - "({ \"data-test-subj\": dataTestSubj, className, children, handlers, showNoResult, }: VisualizationContainerProps) => JSX.Element" + "({ \"data-test-subj\": dataTestSubj, className, children, handlers, showNoResult, error, }: ", + "VisualizationContainerProps", + ") => JSX.Element" ], "description": [], "label": "VisualizationContainer", "source": { "path": "src/plugins/visualizations/public/components/visualization_container.tsx", - "lineNumber": 23 + "lineNumber": 27 }, "tags": [], "returnComment": [], @@ -984,7 +1425,7 @@ "description": [], "source": { "path": "src/plugins/visualizations/public/vis_types/types.ts", - "lineNumber": 30 + "lineNumber": 25 }, "signature": [ { @@ -1005,7 +1446,7 @@ "description": [], "source": { "path": "src/plugins/visualizations/public/vis_types/types.ts", - "lineNumber": 31 + "lineNumber": 26 }, "signature": [ { @@ -1026,7 +1467,7 @@ "description": [], "source": { "path": "src/plugins/visualizations/public/vis_types/types.ts", - "lineNumber": 32 + "lineNumber": 27 }, "signature": [ { @@ -1042,7 +1483,7 @@ ], "source": { "path": "src/plugins/visualizations/public/vis_types/types.ts", - "lineNumber": 29 + "lineNumber": 24 }, "initialIsOpen": false }, @@ -1153,7 +1594,7 @@ "description": [], "source": { "path": "src/plugins/visualizations/public/vis_types/types.ts", - "lineNumber": 36 + "lineNumber": 31 }, "signature": [ "string[]" @@ -1167,7 +1608,7 @@ "description": [], "source": { "path": "src/plugins/visualizations/public/vis_types/types.ts", - "lineNumber": 37 + "lineNumber": 32 }, "signature": [ "node_modules/utility-types/dist/utility-types", @@ -1182,7 +1623,7 @@ "description": [], "source": { "path": "src/plugins/visualizations/public/vis_types/types.ts", - "lineNumber": 38 + "lineNumber": 33 } }, { @@ -1193,7 +1634,7 @@ "description": [], "source": { "path": "src/plugins/visualizations/public/vis_types/types.ts", - "lineNumber": 39 + "lineNumber": 34 } }, { @@ -1204,7 +1645,7 @@ "description": [], "source": { "path": "src/plugins/visualizations/public/vis_types/types.ts", - "lineNumber": 40 + "lineNumber": 35 } }, { @@ -1215,7 +1656,7 @@ "description": [], "source": { "path": "src/plugins/visualizations/public/vis_types/types.ts", - "lineNumber": 41 + "lineNumber": 36 }, "signature": [ { @@ -1236,7 +1677,7 @@ "description": [], "source": { "path": "src/plugins/visualizations/public/vis_types/types.ts", - "lineNumber": 42 + "lineNumber": 37 } }, { @@ -1247,7 +1688,7 @@ "description": [], "source": { "path": "src/plugins/visualizations/public/vis_types/types.ts", - "lineNumber": 43 + "lineNumber": 38 }, "signature": [ "unknown" @@ -1261,7 +1702,7 @@ "description": [], "source": { "path": "src/plugins/visualizations/public/vis_types/types.ts", - "lineNumber": 44 + "lineNumber": 39 }, "signature": [ "boolean | undefined" @@ -1275,7 +1716,7 @@ "description": [], "source": { "path": "src/plugins/visualizations/public/vis_types/types.ts", - "lineNumber": 45 + "lineNumber": 40 }, "signature": [ "boolean | undefined" @@ -1289,7 +1730,7 @@ "description": [], "source": { "path": "src/plugins/visualizations/public/vis_types/types.ts", - "lineNumber": 46 + "lineNumber": 41 }, "signature": [ "any" @@ -1303,7 +1744,7 @@ "description": [], "source": { "path": "src/plugins/visualizations/public/vis_types/types.ts", - "lineNumber": 47 + "lineNumber": 42 }, "signature": [ "boolean | undefined" @@ -1317,7 +1758,7 @@ "description": [], "source": { "path": "src/plugins/visualizations/public/vis_types/types.ts", - "lineNumber": 48 + "lineNumber": 43 }, "signature": [ "React.ReactNode" @@ -1326,7 +1767,7 @@ ], "source": { "path": "src/plugins/visualizations/public/vis_types/types.ts", - "lineNumber": 35 + "lineNumber": 30 }, "initialIsOpen": false }, @@ -2220,13 +2661,7 @@ "lineNumber": 44 }, "signature": [ - { - "pluginId": "visualizations", - "scope": "public", - "docId": "kibVisualizationsPluginApi", - "section": "def-public.VisualizationStage", - "text": "VisualizationStage" - } + "\"experimental\" | \"beta\" | \"production\"" ] }, { @@ -2281,7 +2716,7 @@ ], "source": { "path": "src/plugins/visualizations/public/vis_types/types.ts", - "lineNumber": 83 + "lineNumber": 78 } }, { @@ -2294,7 +2729,7 @@ ], "source": { "path": "src/plugins/visualizations/public/vis_types/types.ts", - "lineNumber": 87 + "lineNumber": 82 } }, { @@ -2307,7 +2742,7 @@ ], "source": { "path": "src/plugins/visualizations/public/vis_types/types.ts", - "lineNumber": 91 + "lineNumber": 86 }, "signature": [ "string | undefined" @@ -2323,7 +2758,7 @@ ], "source": { "path": "src/plugins/visualizations/public/vis_types/types.ts", - "lineNumber": 95 + "lineNumber": 90 }, "signature": [ "string | undefined" @@ -2339,7 +2774,7 @@ ], "source": { "path": "src/plugins/visualizations/public/vis_types/types.ts", - "lineNumber": 99 + "lineNumber": 94 }, "signature": [ "(() => string[]) | undefined" @@ -2355,7 +2790,7 @@ ], "source": { "path": "src/plugins/visualizations/public/vis_types/types.ts", - "lineNumber": 105 + "lineNumber": 100 }, "signature": [ "((visParams: ", @@ -2393,7 +2828,7 @@ "description": [], "source": { "path": "src/plugins/visualizations/public/vis_types/types.ts", - "lineNumber": 107 + "lineNumber": 102 }, "signature": [ "boolean | undefined" @@ -2409,7 +2844,7 @@ ], "source": { "path": "src/plugins/visualizations/public/vis_types/types.ts", - "lineNumber": 111 + "lineNumber": 106 }, "signature": [ "string | React.ComponentClass<{}, any> | React.FunctionComponent<{}> | undefined" @@ -2425,7 +2860,7 @@ ], "source": { "path": "src/plugins/visualizations/public/vis_types/types.ts", - "lineNumber": 115 + "lineNumber": 110 }, "signature": [ "string | undefined" @@ -2443,7 +2878,7 @@ ], "source": { "path": "src/plugins/visualizations/public/vis_types/types.ts", - "lineNumber": 120 + "lineNumber": 115 }, "signature": [ "\"experimental\" | \"beta\" | \"production\" | undefined" @@ -2461,7 +2896,7 @@ ], "source": { "path": "src/plugins/visualizations/public/vis_types/types.ts", - "lineNumber": 126 + "lineNumber": 121 }, "signature": [ { @@ -2484,7 +2919,7 @@ ], "source": { "path": "src/plugins/visualizations/public/vis_types/types.ts", - "lineNumber": 132 + "lineNumber": 127 }, "signature": [ "string | undefined" @@ -2500,7 +2935,7 @@ ], "source": { "path": "src/plugins/visualizations/public/vis_types/types.ts", - "lineNumber": 138 + "lineNumber": 133 }, "signature": [ "boolean | undefined" @@ -2514,7 +2949,7 @@ "description": [], "source": { "path": "src/plugins/visualizations/public/vis_types/types.ts", - "lineNumber": 139 + "lineNumber": 134 }, "signature": [ "boolean | ((vis: { params: TVisParams; }) => boolean) | undefined" @@ -2528,7 +2963,7 @@ "description": [], "source": { "path": "src/plugins/visualizations/public/vis_types/types.ts", - "lineNumber": 140 + "lineNumber": 135 }, "signature": [ { @@ -2559,7 +2994,7 @@ ], "source": { "path": "src/plugins/visualizations/public/vis_types/types.ts", - "lineNumber": 147 + "lineNumber": 142 }, "signature": [ "((vis: ", @@ -2591,7 +3026,7 @@ ], "source": { "path": "src/plugins/visualizations/public/vis_types/types.ts", - "lineNumber": 153 + "lineNumber": 148 }, "signature": [ { @@ -2612,7 +3047,7 @@ "description": [], "source": { "path": "src/plugins/visualizations/public/vis_types/types.ts", - "lineNumber": 155 + "lineNumber": 150 }, "signature": [ "((vis: ", @@ -2642,7 +3077,7 @@ "description": [], "source": { "path": "src/plugins/visualizations/public/vis_types/types.ts", - "lineNumber": 156 + "lineNumber": 151 }, "signature": [ "boolean | undefined" @@ -2656,7 +3091,7 @@ "description": [], "source": { "path": "src/plugins/visualizations/public/vis_types/types.ts", - "lineNumber": 158 + "lineNumber": 153 }, "signature": [ "Partial<", @@ -2674,7 +3109,7 @@ ], "source": { "path": "src/plugins/visualizations/public/vis_types/types.ts", - "lineNumber": 164 + "lineNumber": 159 }, "signature": [ "DefaultEditorConfig | CustomEditorConfig" @@ -2690,7 +3125,7 @@ ], "source": { "path": "src/plugins/visualizations/public/vis_types/types.ts", - "lineNumber": 170 + "lineNumber": 165 }, "signature": [ "Record" @@ -2699,7 +3134,7 @@ ], "source": { "path": "src/plugins/visualizations/public/vis_types/types.ts", - "lineNumber": 79 + "lineNumber": 74 }, "initialIsOpen": false }, @@ -2782,13 +3217,7 @@ "lineNumber": 19 }, "signature": [ - { - "pluginId": "visualizations", - "scope": "public", - "docId": "kibVisualizationsPluginApi", - "section": "def-public.VisualizationStage", - "text": "VisualizationStage" - } + "\"experimental\" | \"beta\" | \"production\"" ] }, { @@ -3033,8 +3462,8 @@ "tags": [], "description": [], "source": { - "path": "src/plugins/visualizations/public/vis_types/types.ts", - "lineNumber": 23 + "path": "src/plugins/visualizations/public/vis_types/vis_groups_enum.ts", + "lineNumber": 9 }, "initialIsOpen": false } @@ -3155,10 +3584,10 @@ "description": [], "source": { "path": "src/plugins/visualizations/public/index.ts", - "lineNumber": 31 + "lineNumber": 30 }, "signature": [ - "{ readonly type: \"visualization\"; readonly id: string; destroy: () => void; readonly parent?: ", + "{ readonly type: \"visualization\"; readonly id: string; getDescription: () => string; destroy: () => void; readonly parent?: ", { "pluginId": "embeddable", "scope": "public", @@ -3182,7 +3611,7 @@ "section": "def-public.ContainerOutput", "text": "ContainerOutput" }, - "> | undefined; render: (domNode: HTMLElement) => Promise; getDescription: () => string; getInspectorAdapters: () => ", + "> | undefined; render: (domNode: HTMLElement) => Promise; getInspectorAdapters: () => ", { "pluginId": "inspector", "scope": "common", @@ -3209,7 +3638,7 @@ "description": [], "source": { "path": "src/plugins/visualizations/public/index.ts", - "lineNumber": 30 + "lineNumber": 29 }, "signature": [ "{ readonly type: \"visualization\"; create: (input: ", @@ -3340,7 +3769,7 @@ ], "source": { "path": "src/plugins/visualizations/public/plugin.ts", - "lineNumber": 74 + "lineNumber": 76 }, "signature": [ "{ createBaseVisualization: (config: ", @@ -3377,9 +3806,21 @@ "text": "VisualizationsStart" }, " extends { get: (visualization: string) => ", - "BaseVisType", + { + "pluginId": "visualizations", + "scope": "public", + "docId": "kibVisualizationsPluginApi", + "section": "def-public.BaseVisType", + "text": "BaseVisType" + }, " | undefined; all: () => ", - "BaseVisType", + { + "pluginId": "visualizations", + "scope": "public", + "docId": "kibVisualizationsPluginApi", + "section": "def-public.BaseVisType", + "text": "BaseVisType" + }, "<", { "pluginId": "visualizations", @@ -3408,7 +3849,7 @@ "description": [], "source": { "path": "src/plugins/visualizations/public/plugin.ts", - "lineNumber": 77 + "lineNumber": 79 }, "signature": [ { @@ -3431,7 +3872,7 @@ "description": [], "source": { "path": "src/plugins/visualizations/public/plugin.ts", - "lineNumber": 78 + "lineNumber": 80 }, "signature": [ "(visType: string, visState: ", @@ -3477,7 +3918,7 @@ "description": [], "source": { "path": "src/plugins/visualizations/public/plugin.ts", - "lineNumber": 79 + "lineNumber": 81 }, "signature": [ "(savedVis: ", @@ -3515,7 +3956,7 @@ "description": [], "source": { "path": "src/plugins/visualizations/public/plugin.ts", - "lineNumber": 80 + "lineNumber": 82 }, "signature": [ "(vis: ", @@ -3552,7 +3993,7 @@ "description": [], "source": { "path": "src/plugins/visualizations/public/plugin.ts", - "lineNumber": 81 + "lineNumber": 83 }, "signature": [ "typeof ", @@ -3567,7 +4008,7 @@ "description": [], "source": { "path": "src/plugins/visualizations/public/plugin.ts", - "lineNumber": 82 + "lineNumber": 84 }, "signature": [ "{ createVisEmbeddableFromObject: (vis: ", @@ -3609,7 +4050,7 @@ ], "source": { "path": "src/plugins/visualizations/public/plugin.ts", - "lineNumber": 76 + "lineNumber": 78 }, "lifecycle": "start", "initialIsOpen": true diff --git a/docs/developer/plugin-list.asciidoc b/docs/developer/plugin-list.asciidoc index 6f94ce6cec3bd..067b6b206fa14 100644 --- a/docs/developer/plugin-list.asciidoc +++ b/docs/developer/plugin-list.asciidoc @@ -125,7 +125,7 @@ in Kibana, e.g. visualizations. It has the form of a flyout panel. |{kib-repo}blob/{branch}/src/plugins/kibana_usage_collection/README.md[kibanaUsageCollection] -|This plugin registers the basic usage collectors from Kibana: +|This plugin registers the Platform Usage Collectors in Kibana. |{kib-repo}blob/{branch}/src/plugins/kibana_utils/README.md[kibanaUtils] diff --git a/docs/development/core/public/kibana-plugin-core-public.doclinksstart.md b/docs/development/core/public/kibana-plugin-core-public.doclinksstart.md index 4242159ff3c20..91ef8358b5fd2 100644 --- a/docs/development/core/public/kibana-plugin-core-public.doclinksstart.md +++ b/docs/development/core/public/kibana-plugin-core-public.doclinksstart.md @@ -17,5 +17,5 @@ export interface DocLinksStart | --- | --- | --- | | [DOC\_LINK\_VERSION](./kibana-plugin-core-public.doclinksstart.doc_link_version.md) | string | | | [ELASTIC\_WEBSITE\_URL](./kibana-plugin-core-public.doclinksstart.elastic_website_url.md) | string | | -| [links](./kibana-plugin-core-public.doclinksstart.links.md) | {
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<string, string>;
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 indexPatterns: {
readonly introduction: string;
readonly fieldFormattersNumber: string;
readonly fieldFormattersString: string;
};
readonly addData: string;
readonly kibana: string;
readonly upgradeAssistant: string;
readonly elasticsearch: Record<string, string>;
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<string, string>;
readonly ml: Record<string, string>;
readonly transforms: Record<string, string>;
readonly visualize: Record<string, string>;
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<string, string>;
readonly alerting: Record<string, string>;
readonly maps: Record<string, string>;
readonly monitoring: Record<string, string>;
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<string, string>;
readonly ccs: Record<string, string>;
readonly plugins: Record<string, string>;
readonly snapshotRestore: Record<string, string>;
readonly ingest: Record<string, string>;
} | | +| [links](./kibana-plugin-core-public.doclinksstart.links.md) | {
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<string, string>;
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<string, string>;
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<string, string>;
readonly ml: Record<string, string>;
readonly transforms: Record<string, string>;
readonly visualize: Record<string, string>;
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<string, string>;
readonly alerting: Record<string, string>;
readonly maps: Record<string, string>;
readonly monitoring: Record<string, string>;
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<string, string>;
readonly ccs: Record<string, string>;
readonly plugins: Record<string, string>;
readonly snapshotRestore: Record<string, string>;
readonly ingest: Record<string, string>;
} | | diff --git a/src/plugins/kibana_usage_collection/README.md b/src/plugins/kibana_usage_collection/README.md index 9e9438b1b5fee..1cb14cdef647e 100644 --- a/src/plugins/kibana_usage_collection/README.md +++ b/src/plugins/kibana_usage_collection/README.md @@ -1,14 +1,18 @@ # Kibana Usage Collection -This plugin registers the basic usage collectors from Kibana: +This plugin registers the Platform Usage Collectors in Kibana. -- [Application Usage](./server/collectors/application_usage/README.md) -- Core Metrics -- [Config Usage](./server/collectors/config_usage/README.md) -- CSP configuration -- Kibana: Number of Saved Objects per type -- Localization data -- [User-changed UI Settings](./server/collectors/management/README.md) -- Ops stats -- UI Counts -- UI Metrics +| Collector name | Description | Extended documentation | +|----------------|:------------|:----------------------:| +| **Application Usage** | Measures how popular an App in Kibana is by reporting the on-screen time and the number of general clicks that happen in it. | [Link](./server/collectors/application_usage/README.md) | +| **Core Metrics** | Collects the usage reported by the core APIs | - | +| **Config Usage** | Reports the non-default values set via `kibana.yml` config file or CLI options. It `[redacts]` any potential PII-sensitive values. | [Link](./server/collectors/config_usage/README.md) | +| **User-changed UI Settings** | Reports all the UI Settings that have been overwritten by the user. It `[redacts]` any potential PII-sensitive values. | [Link](./server/collectors/management/README.md) | +| **CSP configuration** | Reports the key values regarding the CSP configuration. | - | +| **Kibana** | It reports the number of Saved Objects per type. It is limited to `dashboard`, `visualization`, `search`, `index-pattern`, `graph-workspace` and `timelion-sheet`.
It exists for legacy purposes, and may still be used by Monitoring via Metricbeat. | - | +| **Saved Objects Counts** | Number of Saved Objects per type. | - | +| **Localization data** | Localization settings: setup locale and installed translation files. | - | +| **Ops stats** | Operation metrics from the system. | - | +| **UI Counters** | Daily aggregation of the number of times an event occurs in the UI. | [Link](../usage_collection/README.mdx#ui-counters) | +| **UI Metrics** | Deprecated. Old form of UI Counters. It reports the _count of the repetitions since the cluster's first start_ of any UI events that may have happened. | - | +| **Usage Counters** | Daily aggregation of the number of times an event occurs on the Server. | [Link](../usage_collection/README.mdx#usage-counters) | diff --git a/src/plugins/kibana_usage_collection/server/collectors/index.ts b/src/plugins/kibana_usage_collection/server/collectors/index.ts index 94ed0eefe7a06..761989938e56d 100644 --- a/src/plugins/kibana_usage_collection/server/collectors/index.ts +++ b/src/plugins/kibana_usage_collection/server/collectors/index.ts @@ -9,7 +9,10 @@ export { registerUiMetricUsageCollector } from './ui_metric'; export { registerManagementUsageCollector } from './management'; export { registerApplicationUsageCollector } from './application_usage'; -export { registerKibanaUsageCollector } from './kibana'; +export { + registerKibanaUsageCollector, + registerSavedObjectsCountUsageCollector, +} from './saved_objects_counts'; export { registerOpsStatsCollector } from './ops_stats'; export { registerCloudProviderUsageCollector } from './cloud'; export { registerCspCollector } from './csp'; diff --git a/src/plugins/kibana_usage_collection/server/collectors/kibana/get_saved_object_counts.test.ts b/src/plugins/kibana_usage_collection/server/collectors/kibana/get_saved_object_counts.test.ts deleted file mode 100644 index 3d5d7854d6f9e..0000000000000 --- a/src/plugins/kibana_usage_collection/server/collectors/kibana/get_saved_object_counts.test.ts +++ /dev/null @@ -1,60 +0,0 @@ -/* - * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one - * or more contributor license agreements. Licensed under the Elastic License - * 2.0 and the Server Side Public License, v 1; you may not use this file except - * in compliance with, at your election, the Elastic License 2.0 or the Server - * Side Public License, v 1. - */ - -import { elasticsearchServiceMock } from '../../../../../../src/core/server/mocks'; -import { getSavedObjectsCounts } from './get_saved_object_counts'; - -export function mockGetSavedObjectsCounts(params: TBody) { - const esClient = elasticsearchServiceMock.createClusterClient().asInternalUser; - esClient.search.mockResolvedValue( - // @ts-expect-error we only care about the response body - { body: { ...params } } - ); - return esClient; -} - -describe('getSavedObjectsCounts', () => { - test('Get all the saved objects equal to 0 because no results were found', async () => { - const esClient = mockGetSavedObjectsCounts({}); - - const results = await getSavedObjectsCounts(esClient, '.kibana'); - expect(results).toStrictEqual({ - dashboard: { total: 0 }, - visualization: { total: 0 }, - search: { total: 0 }, - index_pattern: { total: 0 }, - graph_workspace: { total: 0 }, - timelion_sheet: { total: 0 }, - }); - }); - - test('Merge the zeros with the results', async () => { - const esClient = mockGetSavedObjectsCounts({ - aggregations: { - types: { - buckets: [ - { key: 'dashboard', doc_count: 1 }, - { key: 'timelion-sheet', doc_count: 2 }, - { key: 'index-pattern', value: 2 }, // Malformed on purpose - { key: 'graph_workspace', doc_count: 3 }, // already snake_cased - ], - }, - }, - }); - - const results = await getSavedObjectsCounts(esClient, '.kibana'); - expect(results).toStrictEqual({ - dashboard: { total: 1 }, - visualization: { total: 0 }, - search: { total: 0 }, - index_pattern: { total: 0 }, - graph_workspace: { total: 3 }, - timelion_sheet: { total: 2 }, - }); - }); -}); diff --git a/src/plugins/kibana_usage_collection/server/collectors/kibana/get_saved_object_counts.ts b/src/plugins/kibana_usage_collection/server/collectors/kibana/get_saved_object_counts.ts deleted file mode 100644 index 42363f71ef87a..0000000000000 --- a/src/plugins/kibana_usage_collection/server/collectors/kibana/get_saved_object_counts.ts +++ /dev/null @@ -1,75 +0,0 @@ -/* - * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one - * or more contributor license agreements. Licensed under the Elastic License - * 2.0 and the Server Side Public License, v 1; you may not use this file except - * in compliance with, at your election, the Elastic License 2.0 or the Server - * Side Public License, v 1. - */ - -/** - * Moved from /x-pack/plugins/monitoring/server/kibana_monitoring/collectors/get_kibana_usage_collector.ts - * - * The PR https://github.com/elastic/kibana/pull/62665 proved what the issue https://github.com/elastic/kibana/issues/58249 - * was claiming: the structure and payload for common telemetry bits differs between Monitoring and OSS/X-Pack collections. - * - * Unifying this logic from Monitoring that makes sense to have in OSS here and we will import it on the monitoring side to reuse it. - */ - -import { snakeCase } from 'lodash'; -import { ElasticsearchClient } from 'src/core/server'; - -const TYPES = [ - 'dashboard', - 'visualization', - 'search', - 'index-pattern', - 'graph-workspace', - 'timelion-sheet', -]; - -export interface KibanaSavedObjectCounts { - dashboard: { total: number }; - visualization: { total: number }; - search: { total: number }; - index_pattern: { total: number }; - graph_workspace: { total: number }; - timelion_sheet: { total: number }; -} - -export async function getSavedObjectsCounts( - esClient: ElasticsearchClient, - kibanaIndex: string // Typically '.kibana'. We might need a way to obtain it from the SavedObjects client (or the SavedObjects client to provide a way to run aggregations?) -): Promise { - const savedObjectCountSearchParams = { - index: kibanaIndex, - ignoreUnavailable: true, - filterPath: 'aggregations.types.buckets', - body: { - size: 0, - query: { - terms: { type: TYPES }, - }, - aggs: { - types: { - terms: { field: 'type', size: TYPES.length }, - }, - }, - }, - }; - const { body } = await esClient.search(savedObjectCountSearchParams); - const buckets: Array<{ key: string; doc_count: number }> = - // @ts-expect-error @elastic/elasticsearch Aggregate does not include `buckets` - body.aggregations?.types?.buckets || []; - - // Initialise the object with all zeros for all the types - const allZeros: KibanaSavedObjectCounts = TYPES.reduce( - (acc, type) => ({ ...acc, [snakeCase(type)]: { total: 0 } }), - {} as KibanaSavedObjectCounts - ); - - // Add the doc_count from each bucket - return buckets.reduce( - (acc, { key, doc_count: total }) => (total ? { ...acc, [snakeCase(key)]: { total } } : acc), - allZeros - ); -} diff --git a/src/plugins/kibana_usage_collection/server/collectors/kibana/kibana_usage_collector.ts b/src/plugins/kibana_usage_collection/server/collectors/kibana/kibana_usage_collector.ts deleted file mode 100644 index d9f4718cdb475..0000000000000 --- a/src/plugins/kibana_usage_collection/server/collectors/kibana/kibana_usage_collector.ts +++ /dev/null @@ -1,76 +0,0 @@ -/* - * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one - * or more contributor license agreements. Licensed under the Elastic License - * 2.0 and the Server Side Public License, v 1; you may not use this file except - * in compliance with, at your election, the Elastic License 2.0 or the Server - * Side Public License, v 1. - */ - -import { Observable } from 'rxjs'; -import { take } from 'rxjs/operators'; -import { SharedGlobalConfig } from 'kibana/server'; -import { UsageCollectionSetup } from 'src/plugins/usage_collection/server'; -import { getSavedObjectsCounts, KibanaSavedObjectCounts } from './get_saved_object_counts'; - -interface KibanaUsage extends KibanaSavedObjectCounts { - index: string; -} - -export function getKibanaUsageCollector( - usageCollection: UsageCollectionSetup, - legacyConfig$: Observable -) { - return usageCollection.makeUsageCollector({ - type: 'kibana', - isReady: () => true, - schema: { - index: { type: 'keyword', _meta: { description: 'The index storing the saved objects' } }, - dashboard: { - total: { type: 'long', _meta: { description: 'Total number of dashboard saved objects' } }, - }, - visualization: { - total: { - type: 'long', - _meta: { description: 'Total number of visualization saved objects' }, - }, - }, - search: { - total: { type: 'long', _meta: { description: 'Total number of search saved objects' } }, - }, - index_pattern: { - total: { - type: 'long', - _meta: { description: 'Total number of index_pattern saved objects' }, - }, - }, - graph_workspace: { - total: { - type: 'long', - _meta: { description: 'Total number of graph_workspace saved objects' }, - }, - }, - timelion_sheet: { - total: { - type: 'long', - _meta: { description: 'Total number of timelion_sheet saved objects' }, - }, - }, - }, - async fetch({ esClient }) { - const { - kibana: { index }, - } = await legacyConfig$.pipe(take(1)).toPromise(); - return { - index, - ...(await getSavedObjectsCounts(esClient, index)), - }; - }, - }); -} - -export function registerKibanaUsageCollector( - usageCollection: UsageCollectionSetup, - legacyConfig$: Observable -) { - usageCollection.registerCollector(getKibanaUsageCollector(usageCollection, legacyConfig$)); -} diff --git a/src/plugins/kibana_usage_collection/server/collectors/saved_objects_counts/get_saved_object_counts.test.ts b/src/plugins/kibana_usage_collection/server/collectors/saved_objects_counts/get_saved_object_counts.test.ts new file mode 100644 index 0000000000000..94c618354fc37 --- /dev/null +++ b/src/plugins/kibana_usage_collection/server/collectors/saved_objects_counts/get_saved_object_counts.test.ts @@ -0,0 +1,80 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0 and the Server Side Public License, v 1; you may not use this file except + * in compliance with, at your election, the Elastic License 2.0 or the Server + * Side Public License, v 1. + */ + +import { elasticsearchServiceMock } from '../../../../../../src/core/server/mocks'; +import { getSavedObjectsCounts } from './get_saved_object_counts'; + +function mockGetSavedObjectsCounts(params: TBody) { + const esClient = elasticsearchServiceMock.createClusterClient().asInternalUser; + esClient.search.mockResolvedValue( + // @ts-expect-error we only care about the response body + { body: { ...params } } + ); + return esClient; +} + +describe('getSavedObjectsCounts', () => { + test('should not fail if no body returned', async () => { + const esClient = mockGetSavedObjectsCounts({}); + + const results = await getSavedObjectsCounts(esClient, '.kibana'); + expect(results).toStrictEqual([]); + expect(esClient.search).toHaveBeenCalledWith({ + index: '.kibana', + ignoreUnavailable: true, + filterPath: 'aggregations.types.buckets', + body: { + size: 0, + query: { match_all: {} }, + aggs: { types: { terms: { field: 'type' } } }, + }, + }); + }); + + test('should match all when no types specified', async () => { + const esClient = mockGetSavedObjectsCounts({}); + await getSavedObjectsCounts(esClient, '.kibana'); + expect(esClient.search).toHaveBeenCalledWith({ + index: '.kibana', + ignoreUnavailable: true, + filterPath: 'aggregations.types.buckets', + body: { + size: 0, + query: { match_all: {} }, + aggs: { types: { terms: { field: 'type' } } }, + }, + }); + }); + + test('should terms query when types are specified', async () => { + const esClient = mockGetSavedObjectsCounts({}); + await getSavedObjectsCounts(esClient, '.kibana', ['type_one', 'type_two']); + expect(esClient.search).toHaveBeenCalledWith({ + index: '.kibana', + ignoreUnavailable: true, + filterPath: 'aggregations.types.buckets', + body: { + size: 0, + query: { terms: { type: ['type_one', 'type_two'] } }, + aggs: { types: { terms: { field: 'type' } } }, + }, + }); + }); + + test('return the buckets as they are', async () => { + const buckets = [ + { key: 'type_one', doc_count: 1 }, + { key: 'type-two', doc_count: 2 }, + ]; + + const esClient = mockGetSavedObjectsCounts({ aggregations: { types: { buckets } } }); + + const results = await getSavedObjectsCounts(esClient, '.kibana'); + expect(results).toStrictEqual(buckets); + }); +}); diff --git a/src/plugins/kibana_usage_collection/server/collectors/saved_objects_counts/get_saved_object_counts.ts b/src/plugins/kibana_usage_collection/server/collectors/saved_objects_counts/get_saved_object_counts.ts new file mode 100644 index 0000000000000..9927b27da6c8f --- /dev/null +++ b/src/plugins/kibana_usage_collection/server/collectors/saved_objects_counts/get_saved_object_counts.ts @@ -0,0 +1,31 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0 and the Server Side Public License, v 1; you may not use this file except + * in compliance with, at your election, the Elastic License 2.0 or the Server + * Side Public License, v 1. + */ + +import { ElasticsearchClient } from 'src/core/server'; + +export async function getSavedObjectsCounts( + esClient: ElasticsearchClient, + kibanaIndex: string, // Typically '.kibana'. We might need a way to obtain it from the SavedObjects client (or the SavedObjects client to provide a way to run aggregations?) + onlyTypes: string[] = [] +): Promise> { + const query = onlyTypes.length ? { terms: { type: onlyTypes } } : { match_all: {} }; + + const savedObjectCountSearchParams = { + index: kibanaIndex, + ignoreUnavailable: true, + filterPath: 'aggregations.types.buckets', + body: { + size: 0, + query, + aggs: { types: { terms: { field: 'type' } } }, + }, + }; + const { body } = await esClient.search(savedObjectCountSearchParams); + // @ts-expect-error @elastic/elasticsearch Aggregate does not include `buckets` + return body.aggregations?.types?.buckets || []; +} diff --git a/src/plugins/kibana_usage_collection/server/collectors/kibana/index.ts b/src/plugins/kibana_usage_collection/server/collectors/saved_objects_counts/index.ts similarity index 82% rename from src/plugins/kibana_usage_collection/server/collectors/kibana/index.ts rename to src/plugins/kibana_usage_collection/server/collectors/saved_objects_counts/index.ts index 0997d44f3c621..706a9e3229813 100644 --- a/src/plugins/kibana_usage_collection/server/collectors/kibana/index.ts +++ b/src/plugins/kibana_usage_collection/server/collectors/saved_objects_counts/index.ts @@ -7,3 +7,4 @@ */ export { registerKibanaUsageCollector } from './kibana_usage_collector'; +export { registerSavedObjectsCountUsageCollector } from './saved_objects_count_collector'; diff --git a/src/plugins/kibana_usage_collection/server/collectors/kibana/index.test.ts b/src/plugins/kibana_usage_collection/server/collectors/saved_objects_counts/kibana_usage_collector.test.ts similarity index 54% rename from src/plugins/kibana_usage_collection/server/collectors/kibana/index.test.ts rename to src/plugins/kibana_usage_collection/server/collectors/saved_objects_counts/kibana_usage_collector.test.ts index 2c75d3edc3a84..6097910afe22b 100644 --- a/src/plugins/kibana_usage_collection/server/collectors/kibana/index.test.ts +++ b/src/plugins/kibana_usage_collection/server/collectors/saved_objects_counts/kibana_usage_collector.test.ts @@ -16,11 +16,11 @@ import { createCollectorFetchContextMock, createUsageCollectionSetupMock, } from '../../../../usage_collection/server/mocks'; -import { registerKibanaUsageCollector } from './'; +import { getKibanaSavedObjectCounts, registerKibanaUsageCollector } from './kibana_usage_collector'; const logger = loggingSystemMock.createLogger(); -describe('telemetry_kibana', () => { +describe('kibana_usage', () => { let collector: Collector; const usageCollectionMock = createUsageCollectionSetupMock(); @@ -60,3 +60,53 @@ describe('telemetry_kibana', () => { }); }); }); + +function mockGetSavedObjectsCounts(params: TBody) { + const esClient = elasticsearchServiceMock.createClusterClient().asInternalUser; + esClient.search.mockResolvedValue( + // @ts-expect-error we only care about the response body + { body: { ...params } } + ); + return esClient; +} + +describe('getKibanaSavedObjectCounts', () => { + test('Get all the saved objects equal to 0 because no results were found', async () => { + const esClient = mockGetSavedObjectsCounts({}); + + const results = await getKibanaSavedObjectCounts(esClient, '.kibana'); + expect(results).toStrictEqual({ + dashboard: { total: 0 }, + visualization: { total: 0 }, + search: { total: 0 }, + index_pattern: { total: 0 }, + graph_workspace: { total: 0 }, + timelion_sheet: { total: 0 }, + }); + }); + + test('Merge the zeros with the results', async () => { + const esClient = mockGetSavedObjectsCounts({ + aggregations: { + types: { + buckets: [ + { key: 'dashboard', doc_count: 1 }, + { key: 'timelion-sheet', doc_count: 2 }, + { key: 'index-pattern', value: 2 }, // Malformed on purpose + { key: 'graph_workspace', doc_count: 3 }, // already snake_cased + ], + }, + }, + }); + + const results = await getKibanaSavedObjectCounts(esClient, '.kibana'); + expect(results).toStrictEqual({ + dashboard: { total: 1 }, + visualization: { total: 0 }, + search: { total: 0 }, + index_pattern: { total: 0 }, + graph_workspace: { total: 3 }, + timelion_sheet: { total: 2 }, + }); + }); +}); diff --git a/src/plugins/kibana_usage_collection/server/collectors/saved_objects_counts/kibana_usage_collector.ts b/src/plugins/kibana_usage_collection/server/collectors/saved_objects_counts/kibana_usage_collector.ts new file mode 100644 index 0000000000000..1ebb61c446083 --- /dev/null +++ b/src/plugins/kibana_usage_collection/server/collectors/saved_objects_counts/kibana_usage_collector.ts @@ -0,0 +1,110 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0 and the Server Side Public License, v 1; you may not use this file except + * in compliance with, at your election, the Elastic License 2.0 or the Server + * Side Public License, v 1. + */ + +import type { Observable } from 'rxjs'; +import type { ElasticsearchClient, SharedGlobalConfig } from 'src/core/server'; +import type { UsageCollectionSetup } from 'src/plugins/usage_collection/server'; +import { take } from 'rxjs/operators'; +import { snakeCase } from 'lodash'; +import { getSavedObjectsCounts } from './get_saved_object_counts'; + +interface KibanaSavedObjectCounts { + dashboard: { total: number }; + visualization: { total: number }; + search: { total: number }; + index_pattern: { total: number }; + graph_workspace: { total: number }; + timelion_sheet: { total: number }; +} + +interface KibanaUsage extends KibanaSavedObjectCounts { + index: string; +} + +const TYPES = [ + 'dashboard', + 'visualization', + 'search', + 'index-pattern', + 'graph-workspace', + 'timelion-sheet', +]; + +export async function getKibanaSavedObjectCounts( + esClient: ElasticsearchClient, + kibanaIndex: string +): Promise { + const buckets = await getSavedObjectsCounts(esClient, kibanaIndex, TYPES); + + const allZeros = (Object.fromEntries( + TYPES.map((type) => [snakeCase(type), { total: 0 }]) + ) as unknown) as KibanaSavedObjectCounts; + + return buckets.reduce((acc, { key, doc_count: total = 0 }) => { + const type = snakeCase(key) as keyof KibanaSavedObjectCounts; + acc[type].total += total; + return acc; + }, allZeros); +} + +export function registerKibanaUsageCollector( + usageCollection: UsageCollectionSetup, + legacyConfig$: Observable +) { + usageCollection.registerCollector( + usageCollection.makeUsageCollector({ + type: 'kibana', + isReady: () => true, + schema: { + index: { type: 'keyword', _meta: { description: 'The index storing the saved objects' } }, + dashboard: { + total: { + type: 'long', + _meta: { description: 'Total number of dashboard saved objects' }, + }, + }, + visualization: { + total: { + type: 'long', + _meta: { description: 'Total number of visualization saved objects' }, + }, + }, + search: { + total: { type: 'long', _meta: { description: 'Total number of search saved objects' } }, + }, + index_pattern: { + total: { + type: 'long', + _meta: { description: 'Total number of index_pattern saved objects' }, + }, + }, + graph_workspace: { + total: { + type: 'long', + _meta: { description: 'Total number of graph_workspace saved objects' }, + }, + }, + timelion_sheet: { + total: { + type: 'long', + _meta: { description: 'Total number of timelion_sheet saved objects' }, + }, + }, + }, + async fetch({ esClient }) { + const { + kibana: { index }, + } = await legacyConfig$.pipe(take(1)).toPromise(); + return { + index, + ...(await getKibanaSavedObjectCounts(esClient, index)), + }; + }, + }) + ); +} diff --git a/src/plugins/kibana_usage_collection/server/collectors/saved_objects_counts/saved_objects_count_collector.test.ts b/src/plugins/kibana_usage_collection/server/collectors/saved_objects_counts/saved_objects_count_collector.test.ts new file mode 100644 index 0000000000000..0ef5bffd40ff7 --- /dev/null +++ b/src/plugins/kibana_usage_collection/server/collectors/saved_objects_counts/saved_objects_count_collector.test.ts @@ -0,0 +1,66 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0 and the Server Side Public License, v 1; you may not use this file except + * in compliance with, at your election, the Elastic License 2.0 or the Server + * Side Public License, v 1. + */ + +import { pluginInitializerContextConfigMock } from '../../../../../core/server/mocks'; +import { + createCollectorFetchContextMock, + createUsageCollectionSetupMock, +} from '../../../../usage_collection/server/mocks'; +import { registerSavedObjectsCountUsageCollector } from './saved_objects_count_collector'; + +describe('saved_objects_count_collector', () => { + const usageCollectionMock = createUsageCollectionSetupMock(); + + const legacyConfig$ = pluginInitializerContextConfigMock({}).legacy.globalConfig$; + + beforeAll(() => registerSavedObjectsCountUsageCollector(usageCollectionMock, legacyConfig$)); + afterAll(() => jest.clearAllTimers()); + + test('registered collector is set', () => { + expect(usageCollectionMock.makeUsageCollector).toHaveBeenCalled(); + expect(usageCollectionMock.registerCollector).toHaveBeenCalled(); + expect(usageCollectionMock.makeUsageCollector.mock.calls[0][0].type).toBe( + 'saved_objects_counts' + ); + }); + + test('should return an empty array when no results are returned', async () => { + const collector = usageCollectionMock.makeUsageCollector.mock.results[0].value; + expect(await collector.fetch(createCollectorFetchContextMock())).toStrictEqual({ + by_type: [], + }); + }); + + test('should return some values when the aggregations return something', async () => { + const fetchContextMock = createCollectorFetchContextMock(); + fetchContextMock.esClient.search = jest.fn().mockImplementation(() => ({ + body: { + aggregations: { + types: { + buckets: [ + { key: 'type_one', doc_count: 20 }, + { key: 'type_two', doc_count: 45 }, + { key: 'type-three', doc_count: 66 }, + { key: 'type-four', doc_count: 0 }, + ], + }, + }, + }, + })); + + const collector = usageCollectionMock.makeUsageCollector.mock.results[0].value; + expect(await collector.fetch(fetchContextMock)).toStrictEqual({ + by_type: [ + { type: 'type_one', count: 20 }, + { type: 'type_two', count: 45 }, + { type: 'type-three', count: 66 }, + { type: 'type-four', count: 0 }, + ], + }); + }); +}); diff --git a/src/plugins/kibana_usage_collection/server/collectors/saved_objects_counts/saved_objects_count_collector.ts b/src/plugins/kibana_usage_collection/server/collectors/saved_objects_counts/saved_objects_count_collector.ts new file mode 100644 index 0000000000000..71bf2da7dc270 --- /dev/null +++ b/src/plugins/kibana_usage_collection/server/collectors/saved_objects_counts/saved_objects_count_collector.ts @@ -0,0 +1,60 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0 and the Server Side Public License, v 1; you may not use this file except + * in compliance with, at your election, the Elastic License 2.0 or the Server + * Side Public License, v 1. + */ + +import type { Observable } from 'rxjs'; +import { take } from 'rxjs/operators'; +import type { SharedGlobalConfig } from 'src/core/server'; +import type { UsageCollectionSetup } from 'src/plugins/usage_collection/server'; +import { getSavedObjectsCounts } from './get_saved_object_counts'; + +interface SavedObjectsCountUsageByType { + type: string; + count: number; +} + +interface SavedObjectsCountUsage { + by_type: SavedObjectsCountUsageByType[]; +} + +export function registerSavedObjectsCountUsageCollector( + usageCollection: UsageCollectionSetup, + legacyConfig$: Observable +) { + usageCollection.registerCollector( + usageCollection.makeUsageCollector({ + type: 'saved_objects_counts', + isReady: () => true, + schema: { + by_type: { + type: 'array', + items: { + type: { type: 'keyword', _meta: { description: 'The SavedObjects type' } }, + count: { + type: 'long', + _meta: { + description: + 'How many SavedObjects of that type are stored in the cluster across all Spaces', + }, + }, + }, + }, + }, + async fetch({ esClient }) { + const { + kibana: { index }, + } = await legacyConfig$.pipe(take(1)).toPromise(); + const buckets = await getSavedObjectsCounts(esClient, index); + return { + by_type: buckets.map(({ key: type, doc_count: count }) => { + return { type, count }; + }), + }; + }, + }) + ); +} diff --git a/src/plugins/kibana_usage_collection/server/plugin.test.ts b/src/plugins/kibana_usage_collection/server/plugin.test.ts index 450c610afc620..2100b9bbb918b 100644 --- a/src/plugins/kibana_usage_collection/server/plugin.test.ts +++ b/src/plugins/kibana_usage_collection/server/plugin.test.ts @@ -69,6 +69,10 @@ describe('kibana_usage_collection', () => { "isReady": true, "type": "kibana", }, + Object { + "isReady": true, + "type": "saved_objects_counts", + }, Object { "isReady": false, "type": "stack_management", diff --git a/src/plugins/kibana_usage_collection/server/plugin.ts b/src/plugins/kibana_usage_collection/server/plugin.ts index c144384e0882f..da6445ce957d8 100644 --- a/src/plugins/kibana_usage_collection/server/plugin.ts +++ b/src/plugins/kibana_usage_collection/server/plugin.ts @@ -6,22 +6,22 @@ * Side Public License, v 1. */ -import { UsageCollectionSetup } from 'src/plugins/usage_collection/server'; +import type { UsageCollectionSetup } from 'src/plugins/usage_collection/server'; import { Subject, Observable } from 'rxjs'; -import { +import type { PluginInitializerContext, CoreSetup, Plugin, ISavedObjectsRepository, IUiSettingsClient, SharedGlobalConfig, - SavedObjectsClient, CoreStart, SavedObjectsServiceSetup, OpsMetrics, Logger, CoreUsageDataStart, -} from '../../../core/server'; +} from 'src/core/server'; +import { SavedObjectsClient } from '../../../core/server'; import { registerApplicationUsageCollector, registerKibanaUsageCollector, @@ -38,6 +38,7 @@ import { registerConfigUsageCollector, registerUsageCountersRollups, registerUsageCountersUsageCollector, + registerSavedObjectsCountUsageCollector, } from './collectors'; interface KibanaUsageCollectionPluginsDepsSetup { @@ -112,6 +113,7 @@ export class KibanaUsageCollectionPlugin implements Plugin { registerOpsStatsCollector(usageCollection, metric$); registerKibanaUsageCollector(usageCollection, this.legacyConfig$); + registerSavedObjectsCountUsageCollector(usageCollection, this.legacyConfig$); registerManagementUsageCollector(usageCollection, getUiSettingsClient); registerUiMetricUsageCollector(usageCollection, registerType, getSavedObjectsClient); registerApplicationUsageCollector( diff --git a/src/plugins/telemetry/schema/oss_plugins.json b/src/plugins/telemetry/schema/oss_plugins.json index 7cd66dc8eef30..30706fb2bfc3c 100644 --- a/src/plugins/telemetry/schema/oss_plugins.json +++ b/src/plugins/telemetry/schema/oss_plugins.json @@ -7600,76 +7600,6 @@ } } }, - "kibana": { - "properties": { - "index": { - "type": "keyword", - "_meta": { - "description": "The index storing the saved objects" - } - }, - "dashboard": { - "properties": { - "total": { - "type": "long", - "_meta": { - "description": "Total number of dashboard saved objects" - } - } - } - }, - "visualization": { - "properties": { - "total": { - "type": "long", - "_meta": { - "description": "Total number of visualization saved objects" - } - } - } - }, - "search": { - "properties": { - "total": { - "type": "long", - "_meta": { - "description": "Total number of search saved objects" - } - } - } - }, - "index_pattern": { - "properties": { - "total": { - "type": "long", - "_meta": { - "description": "Total number of index_pattern saved objects" - } - } - } - }, - "graph_workspace": { - "properties": { - "total": { - "type": "long", - "_meta": { - "description": "Total number of graph_workspace saved objects" - } - } - } - }, - "timelion_sheet": { - "properties": { - "total": { - "type": "long", - "_meta": { - "description": "Total number of timelion_sheet saved objects" - } - } - } - } - } - }, "localization": { "properties": { "locale": { @@ -8351,6 +8281,99 @@ } } }, + "kibana": { + "properties": { + "index": { + "type": "keyword", + "_meta": { + "description": "The index storing the saved objects" + } + }, + "dashboard": { + "properties": { + "total": { + "type": "long", + "_meta": { + "description": "Total number of dashboard saved objects" + } + } + } + }, + "visualization": { + "properties": { + "total": { + "type": "long", + "_meta": { + "description": "Total number of visualization saved objects" + } + } + } + }, + "search": { + "properties": { + "total": { + "type": "long", + "_meta": { + "description": "Total number of search saved objects" + } + } + } + }, + "index_pattern": { + "properties": { + "total": { + "type": "long", + "_meta": { + "description": "Total number of index_pattern saved objects" + } + } + } + }, + "graph_workspace": { + "properties": { + "total": { + "type": "long", + "_meta": { + "description": "Total number of graph_workspace saved objects" + } + } + } + }, + "timelion_sheet": { + "properties": { + "total": { + "type": "long", + "_meta": { + "description": "Total number of timelion_sheet saved objects" + } + } + } + } + } + }, + "saved_objects_counts": { + "properties": { + "by_type": { + "type": "array", + "items": { + "properties": { + "type": { + "type": "keyword", + "_meta": { + "description": "The SavedObjects type" + } + }, + "count": { + "type": "long", + "_meta": { + "description": "How many SavedObjects of that type are stored in the cluster across all Spaces" + } + } + } + } + } + } + }, "ui_counters": { "properties": { "dailyEvents": { diff --git a/test/api_integration/apis/telemetry/telemetry_local.ts b/test/api_integration/apis/telemetry/telemetry_local.ts index c14fc658f2768..f20c6a3d129dd 100644 --- a/test/api_integration/apis/telemetry/telemetry_local.ts +++ b/test/api_integration/apis/telemetry/telemetry_local.ts @@ -127,6 +127,15 @@ export default function ({ getService }: FtrProviderContext) { expect(stats.stack_stats.data[0].doc_count).to.be(0); expect(stats.stack_stats.data[0].ecs_index_count).to.be(0); expect(stats.stack_stats.data[0].size_in_bytes).to.be.a('number'); + + expect(stats.stack_stats.kibana.plugins.saved_objects_counts).to.be.an('object'); + expect(stats.stack_stats.kibana.plugins.saved_objects_counts.by_type).to.be.an('array'); + expect(stats.stack_stats.kibana.plugins.saved_objects_counts.by_type).to.eql([ + { type: 'config', count: 2 }, + { type: 'dashboard', count: 2 }, + { type: 'index-pattern', count: 2 }, + { type: 'visualization', count: 2 }, + ]); }); it('should validate mandatory fields exist', () => { From 6ffe16521860e4ecd6025ef8c396cf432d787a46 Mon Sep 17 00:00:00 2001 From: Brandon Morelli Date: Thu, 6 May 2021 11:29:20 -0700 Subject: [PATCH 06/20] docs: replace error rate image (#99430) --- docs/apm/images/error-rate.png | Bin 182551 -> 190717 bytes 1 file changed, 0 insertions(+), 0 deletions(-) diff --git a/docs/apm/images/error-rate.png b/docs/apm/images/error-rate.png index b43a0cb5d1a78e635517806a63cfdd04bbe5b48e..036c7a08302bd56cabe6a3660b493549725fd1df 100644 GIT binary patch literal 190717 zcmafb1z6Qf^FM+J0s^A696~}sK)ORfxELz5egzc@AgUoSpgX?Ck6;0dg{;k5C9u;NajMiHiv#Lz`?<1BR>Fgd=3q~ zfQ)$)At5<&At4eu8%skIGXpp{v4F^EBss-(9M4;qAt6D@k9LBVAMD`89wsBog`%fm zg$W1-kRoCel6|JF#8DD1%w0?Q_`!hsz0k{XoYoIBh-&vE?2FzB^=i*Qb~x>Iv7C)L z-#uTMK1@95zc%Va^nBL$_;blSd${5^OyWv~{Jf-$0l}LH#z`1fp6Ev$npt1*@$u0y zV}?DVPqp9(hAOt(-d|r{-qOVK)JLGgMFd*W$aeLLRAQ^OXch@SfZITR&#p!OBxIk+ zCkrc0zz3;~!|g*up!Ehv>PWlW`xI5=xO<*d)*NAWaAN2mza?}_i~b5Fd+dO@??dKu z`1oW2g@ecEOYJ*|!$~tENN^lw9~VI&gRDpFTC(S;p;cD7ZPjWpl4oG7avs4)!5YV? z^VXT=R-?FNDV+0V=o>6C!4%BAp!m7#9$#Gvob{oCc_M4;u%b!hL+C$d=;__x%*X>inq+edo8r--|%`iE?5bJ&3|53>J@T*-9nbhM9G{qp3M$I47tw*}EdPS-Pqgb24kD4goGZ#u0 zZ5DDD9gn{?qbkSc{?M{uXI0K&sd+!xJAC1j)s(frm63IYm0M+q6L#(6*@whFvdy3O z5YL#dUSHu~(Yf-wMUQt zoxYrXJ$w7+O{;LLkU{V#ISQS0&E=0>29cmhS#s&HM*(jnC_BYB#V^J4(vZ?B^qD3; zY>CQ{b$4ubvMwDiWiEweKUH>7E~k;TPY0)iQ#a^FRKWLHZCNuWUCVgNn93Hx?8AP; z4>xc&UfKs=pd3paKiN1P7G-%s5KQoxV1i(i1s$w8fcNunS*4Y%4wK zMaEMcUr9CT3DGLC_0;!SQA%vA-s*z9Qrk)BrY7Jj<5m;8(d=Qayb)=kftSW+>Nw^I z+jx1OPn=_$SXNkWO3Q{eGG<~=UTers$;K6Ec@OEVhiUdLT)X}f46ZL?YAZ6j(+rHrC1qC})T zrj(Tm$Uqxn8KTQD&uB3eF)ZnciW!OJWuf}Y+=I9>)ic%0ud1s4LnF7yxEQZ+xLjXj zMQv1_ubfQdTzy$pS#74MO`SQHInPmjuGGt1)BHYLBpbV#t_HhC^0v%W-}={e(9oNq zoQ%1W=M#+EHrwEB$d<{;!U^Ju^htr?*Iu#MA`_9zKuh#|bT#zLXCO{6mme1nM>$8m zb+Pp?E@iG6Yf5e;&H_6N2lwswo6U|B%Qkb7zqq>XgG}Q#RoETb12n!(CDp{Ze7ZzG zbwQ(f9##}=J%O;euv;{^7|~88%Pt$U%Gl3eyH(3nhYoqvQySlySY>HgP!Yi1?h@iy zfiXkXx+-d3T;+-*WG^@j#!>sO&)!{0D?j z2wd>22zm&#@QDv%?x!P-Ja~ju^MK)z#iJ%4A73++s&=+_wiB#d3v#DFmy>au#dHUB zv32{K&6_C}=t}0*l1te7Av{yA<;D(*_dmW9H4ApaGQp2|;%tNNAhQ(T#o3?wEH&y) znW$n4t}t<+JMkiM3F(S_u5vCtBI>)bD+=i!!a!TC%yr_;+1KY zX&Y%@s=RC~`nDwL!x{)s7b{N3XpKlB8ad>p!IRDPR_4axil3 z2<(_n%FL_8@0??^Y;cEx+`{Shqxu;MU=&C1REoB1=LbBs^NCY#)BmFDARk89*h zi%i3JGZ4}V(w)=m;*88KrUmB|YL{n55j6@Tsv@>$MW!j|MzuiNv$Zp3mu=fRH21L` zX|HKF9oKeMYZhB%X8Sa1t{g_T*~YbsFAqbSiFbD&&JL*>$SarQ*04M79=cgyPI|n* zQc}#*&{DXzZ!q>a_4H!jZe?ea+6CWc`?1qNB(B>rwA93|r!0zAleIXU!|&Yw-!i>rCYa^;`A1?NPUC zs-)G6k~O0cNL3w!NBGT2dchv&xwBe>yhpF+P-9k8Qd1nmO8uG(wL2%5(os#@F1NN? z-NiXZ1AjgS720WCRPEbZwbQq&+c%E%yOSbhq6zi=?)(?YXQ_Sd2#I)!ll<)-JH%Q? zh^OgSImcsBmb!Bw+G1=JM$u+`Vnn%)4?}}+P9?-KAy4ilkucx4-udCmOaJo+e-nq- z?T;tSXO)%rK^dnyGQs}TIAjfIE4S? z!^6S(o50=wqmB&l4gCoPKF~J*{YD7$gF^!T!U8@{N$`KxM&U_9_%jWk4V1yXRumE! z2fh{cYzz!6Y>h4L4mV=UfQ*M$VrsTb|$Mx8o%vgAVl9&wuGO za5A|Y$-?%JX#o>tfR->Y(!XN(t8btw4>Xrc&cw;UOikFt9N-x+1|J&-6VHF@|E=V1 zM3|PUcP*LNm|np)g(>>qrpmSkHbR!>z?gP?ck=q9F>K)<4S5)#Q-@*2fBF2MT!7Jh zC_D^*35^fsO-ocIAjfAW!m>)hH-Iwe&pl<}*Ngvt1L=F#h)vDht8j1vaN@$Rm7MNv z%^-ap7A9`r=NBy)bP)}uuTxpqLVPS&P4-4u?*9EWNz1|4CWC1byUMYiM=2>v>u;73 z?{fyThclDb#MRYkgruQFc?%%)PQPo{>>~OFmWjU&M@7{e(0l0tq zh5X11?>|E-}X=9DPRn+0?k~0QV50Ag6p{X zj>q6b#*leLnx^`xpZ{~mm=yPciUCtU#9=7FEQjy&66L4c`+mHOmjVJMUXQgr_i8V! z6D6hB?zpTNaPYiIk3#Z5dvYU#WXn=%^otEzE#05Wia$$Zh}`$(9nIVa6Bc z1oGr}qO6-?GJi*?FgFx7J5jbxFcm9NFrDmJlkfl2x`U2S77f6o!=9gm5QauFVb4ZA zpF&$Xn7rT8y(i$=n2MyT^yW_TjVg%9JQo|^maBi;;%?4+L;%_KwhUERFr(DsknF9o z5^=*w{I?(x;CKjNj>;I_8%7@bKx4d^UG!C$b$(Y2o09NseBOWr!!E$P0XnC+BkuPp zuMT>FdB);7(msqkzIs_<0>h$rJcGZ>`+Z7V%(HP3b-#!iX3f@<3d|3%?>txWf~60Z zvj5KClL1&{N6R(cWu$iu!4w2oNa~Y90Mp^$n*tpRe+8tBoVwZwQz{Gs8h=^UwxWc| z{2jhX-Z20)&iX3A$SEZf=+M}{rb-ni^LGMINdqdraGv5YfvG5{0^n;6GWf4_`_u!i zf3l~)foYr)5AD&hn?n~S^S48PgVN~OUG)y8q9%aO>R7oC|IBST_%D(GiA&YQ@sD75 z`7wK^zA$_lL22J zco@$7jfEtFh&RU=p~;^^x=W1uj}DF1scUM(7AQjc)<@?;^ao>^FZdYW{|KdjbRaS4 zV=WvxMqK#@#B(rK;Wkzhw$vFhoLZh0C?JdsY?R3M!2x$H7a)HEESXLVigq42nOLxVTd-RuXnYByuVTkoKYi;?D;AJY?iW|z*s6>`2 zaE33nOZ~Fi)Joq=63k$LlngkYD98UO&1QSKIJn9REs_1~0$9gb?{Vf<`&DpTPD z93k-gM^g0~oc^w(-#zO$_YWPHXXI;o4E;)9(i}_ZGmWVUkQ4*zHZa%G?@;hg6Oudw zhVpyP<`0v1SNdm4@I{heLjJ+|gOZb_;PiCOdX^Q49O`QRt*kb2=}2zze95OUen}=< zx7E(g;@uu;XI2fHENyb{A4i{cE%ferbYdW@vU&>eH+cLR%3a>yQ+opQ zE!39=(Ks?n;Tyj4$8C6FCL7g>1_zUg$JuHMRAD36*?#)$8zh)nP@Zi}wRFPp43iJa z-1eB%JLLW*m4IT#<@$#2dL^l9>W0yt;`OxZO7%>0i4mFog=G}K1^-WWM>pQY()_5Q z{OopvkVKxy$|5~Tt&aZeg3c{m0MU@_``UL@(f0_h>ilKNt*^#OHyDS8E@TlBI+?fe zib`$W2G$cj5&>gitZVO|{MZqdekS)NUO~9J)^AA^S~cqUga7YYN$n=(Hu;tTdC>t@2Cy zNoSe2TQzCKB~JMf2kUX?M8TH1nw8c%kRC4m+^)tI-{nX&hM3J!U-@p?t|lGJ%{O$} zOQBq?%xdiZP7}8#o@Sg7<*1#i7Y$l+wv76k^H06=_u#I#liz((U z1@Zt|@Ynrt+}mN7p=q}bzpDN?gJQ8;N0iOYgi&_F0UY;>?cf*PiqSVr2)QO-!oG&G21 z$-Q|)1GbI^?E$8fW!Dr)?p5iQ3a8fwy<#(mU5JC9bnc^h%ghfzqE%tcYLZy!qRC)S z=!VI>6T*K}UN1;rISnwXU9~u0Ytn*Wmpt5-M0B2g9{uf=w*^J1+^;d>Nc$|E!l6^c zi3EB3BkhO1A8v6@;_FF?D7S6t9aL4ks`#X}Bbn6q`na}vZ51bFr*m+#UM=i=u{U$! z)ht|$N7JyGo-UL0t{p6g(A&W%bC($rjO}Y@*?7R(kb4Z7kgv)3%)X1H zEDb247nafehJ+g>lWubrpKAGxb0jrJKI@0dn}6P1P8e0;=5^g-s587Jp9;~jHJMVE zTUvg~v~wL6#v=dBw5UF}If#Zln-ZIYx4>62db=vAK*QtZ=5_4S@P|OKLY;Tttj*gt zcaJXhR)Z?D*tl5$y*#*vJ4BRj)(^Fs% zzMjB|$8N3g<%Nay9vmC%uh!30ZjjTbtVaK+i^vq_J9Zt@mcJ7BD2@ZF)x1$!*$Vvu zx`~?7Mx@pD!vTWk5>%dS5N1s;$2-uFYDXk#fM(UROWI^yTpSZVTxv^Zq5cV;|y zsEl`s8V*?UxaDDV;blQTsKSAmr5qcs@u+Pp%@5&mX^tq?kz|9OXFAf;rrTr=Iv$tS zZ;U9;>@r8++HjN>hpexzD&+U+E*N1ir~3pai<-{M`^p4q3o56!L7L1u^=C7&dlyw( z%0!Y6IuqE6;zuAYrP`+3zwpauNk8L{G#h{{yxQMWbaj-Oj@4CvkD{B6Wbj8j0_!-S z@ZMv+sj>gGkU^_tN)&as4X5~d7CZn&7pPKyH&jd$)T7 zXI?nE3dPiZ%BuY_eu(XLEOwZmLCGXr-R-KzphYvtc4~IOp5hCRgKa`CDbH%-;v?p@0nHhSFJqRq#`YoJ{LSU;&rUA|zYO&;(X|7o`Zm9_r^&I<-XaYHLwBIu5qC zk-VI&>NN+yM!b};a|3;1VdF{+p-C*>F^VZZF{+bzly~~$%k6Q3@z#@RP5kmvK_Ai5 z`838yU~S=Dib1@3b>H&~R~J=u(-twpA-~rn6mAFi+p_s8CbQsML?6u%u{%gr9iKjz zZ_y$Yl6Fz|nC?-8{A!-PI_y#>^^CtRVpp3>gC1;h(eM4jb%2rEnCVQR2$h?=*Qi%Mlf{`pgCV0-FZ5!K0>WWv8O6NjX)v zcyxf>|6Ena>|~_5b@^m__4cdF@s$+c*6=JYL!{|n@J<1YKhaAKKeN8NM{wxV5?xO z17L*;s85$uYi8l7t?IFcvCg;|s=YORm|A8LZNk4HWFFleEy6X@yJ#h4T34t_xrc|7 z%{Q50J71*OesbVk(C>N#u6p^WZAb!n_`NYTmMK$`p0Uhw=G;VUAqTxKNV_hmD*64< zP2S1|q3gYS_YRaUAB?A)dd+?8j%KctXBAvM+QUn}diLxemVu!B{9x~;g36}-z}GDZ z$Zm&mfGfASD3P(kZ!gzNbYxTKyni%?wC#L`R>CW{GjK+8Mbbeh^fhY8#&X|6E&ncm z)Fx|ItD2uAiu8 z?wYrU#96aOsr3}1)jx_;WU>9#^GeGDNmG<%eQBPWNP)+vezBPu+vtXx z4!uI)weAi7vdj)LhRjf?qMs5hPWs^0%J0r+cM^LuLT;Pw^Lj_UX3kJvNHeFC^PNc< zs<=kNa0SHP<#{4bPY?c*bN`+k`g zY$*lCvthlm-%{=Or)DpIGtAQrA7Z~b8fBtL>33nDlVAYiyAs8sK)JvjguL_c@Q}Z4 z|BTzOZdS9kOZ-(P2%FY!Fza-eKlJ{?Uz@yZ-twn6s?n} ziv)R&O+8sp)-SUTt}~4t(XyPGs-E%*?JZUUi0UJ{R=1 zWeY8+CM_Qc!@0TjY7PM%6A8)3WmT$-rF3{ffqlS@zP&wt()rm#qU14m@2}J+gkS48 z)Dc1e6(12o$g_JrFx^zV_k&-60AtGH1TTv%Ywq5Nw?Tj=HLLg2Ft(V@pDR(6&901H zh#(IhE4hnfV*O@vnFui)`m?uv@tn_}iv)i$pK@HAQkvhdD>qNO%+xYy8)G(@IN0rV z>x!g%4%jXctfr%#l?9aG%bQ$F$!PjKw6$B`;ViA8+#EqK(=qeV^zNwc^&z9BlWlIp z85Nu5u(lvViC%&c3XAE=6~49)7kkC>iy6SymB^wSPc9RtDiQ*snk&$x$PSJLkK~f- z1QF-?5{m% z7@aX$4CE_5j32sfFC5VK>Z` zako%=`*VhGntWAmvE3;m{@L8#xLa&3O;EQ{c&2)i!tvGF{Fer8l}G#WtkUl=2RTHn z4i{HdvFv>(IA89XJ81H$Gh7=qJ8STLsg7LsI;-cR&YFF={E#oX3bYI#LgP7>qO5`B zUFYH;c1&R3vzJsR+7&r0{u`%47#2 zTsk6645e0V^E&Oxad`|YvspkA6v{zU)zeAtymU^SB7vZnfc2QQYnr!caX#o{wTTcu!Q#NPVr%Eyen!`8&^7vKeUyTKy8Q6Ta49&JNr2 zcQ2KB5p^I=c*X^R#Y{&o)9j1Uwdx8*DLSJ$vs|;a+B0tRTaZuGT;8)l+<2T{Z#G%! zzr*mOF{@DDJRcZZZ!D--uG_ESo$1ZByw4N_@95Cxu<9(fnFGT4?4V|_Q}3oqC!YLB z8Z?{+pX^IVD$W|{oE;4>%5_4y_dWPH8Yfo^IMBVkS*V?wPemz{G1lo?)<&|=PcG`E zf)6o}hz_f}JgISdd2Uf3L9IARvGAmFcd+{js8XU4+ zk+gbIlZa0xqh9P_IVf?vUUaq(9xsOUxNYOqn#dl@O%%#M;e>2eYK4~@NXM~6eR=M; zQO61)bh=s$p;gG7-7Ie_M;bwC(5V;3NUffd;rxr!0^?Bs_3S9;9^UljCnI&s)jl0h zl$~o&6mB+`OhEL6jz(wd%MwhcD`@^dQ)ez?=4aWnPSNZ)>UVZtl`kLGe@j0-Gp_j} z_!k`hZVDhj@zSCy==N8HFHwMQ&_Uign?iUErz0TFy>7beuXO~t5gFLqqMw*#y0nmG zeWxEVaAl~_9@wDB>o$bSxHG;tZjqy6@mFFyxde}xoI@51F0u(^s+C8gj}vH=3xfJc zMNBykex6-0xpb?=oXv$!fSt_C8Zw70Rdze$gvw)TpvU8?XJNiaolnGSIr_Oj*cz?o z)5&f`k3vjYASLlbd9_dbzBFrKNOF(|^-JxDT#uSC==u0+@1YGB#1OkVGThFF` z!gI?ku`kURWm{9XsV#e>BCV0MQ5(GU*}8?ILHL=tmb0}ZZ1$1HXJ z60Cvt;f8ej{RwsG$C0w(zkblSfO9_exubKJ+&P;uGXSTV_v-PHn=iXZLkK>% zwnzy6t_@QF7DYrDg=9wvKd8_xaq#jGG+5MvwBqjIC2E^$&~#D1{>@RNGx%Gu5a)Nf zRnr3HFmmy*j*MOn%~@_>SZVk1^)tSvK_1xqqyP2BVLpJ*#%)C59gS%!sY+DB#O}zM zbn$jBH5W3K=py&3yNdCZLERB_nhMqm56Qg!K87wX`$eXAG9Se0D5@TO^Lp+rhl|bn zg^0TeBiEj7z*}Woi3;`vqfikBerntDn~bqBTETyE-0vJ6eq3FWK1yA0&o+j zXfCdRb1ML%i@Y)}PsB6xtt{&~$CX{@%IT#E%*^22&Y>r2NN@9#%uEbr7+DU#&ghg!+QLqg}`2gf#v2gO&Y2 zU%(`m2qG9Eci0+Ffp}_GxO>}e4Y!V)^@V^qNwO3&hR1l_=9YGEm5TMdP0G`8hA-1i z6sb0J$e7urVz{&(VBj0(ZXD9ZjfyAmR1tN-P;h6|{*m%3#Kx=I@^P)%cDyF(r7?(> zn%rw{iB9-AMvEhsgTeZ28ov^CVdmoUi_-a(vy;sq4%CX?EYir`+e2Y(2|TI}uI1_i zR-xGJ(@tOR{`KQOJUvXOGq;CyChWQ)_4&>2-KC!2VwJvHo_26y4KeuD@2q2(_J2v8 z#EIT`^Wmm;ZRZvwX~W(kUQ=T0CW~Yjs6}y*$4NAX2X3Aa;y7b8wUo;xj3HGMo z8wkg(CRze+;^FsNHpe?couOo2Q{E?Wj>3R{_Pb?4D1V;RmRy(l%+FcOWUuy6&A^L! zDK}3;DF@=|ENxLXQ+q7RQql6ucg3%-AxzF;rv20*#Qaeod_PtB+;`j_Cj$a57-fVK zr`$-g;C(Y?o{jj2+n(ObtRO~)OeSoY>>sT&+wA|MsIuBm;qy4`9ZQcGWe&72Mim*& zQ4!6MNqCn>N&1MV9DG=>>f)`WI~+v#Rx+L=p8;G4IgPBcU5#tEuAf_ZfOBWdH7k*D zA%cWZI9*23vfh?`Qkw}s#RgN!-nu8UU7O-_tVtd^fs+sYiPDThcF+yL291qPOm1yb z{s+2~xPh_k9-<6~M{Yxj9yiqIs9f%(c{7*hX>+*2I&un49pd4c#=CV`64j+9$ERZF z2g_g1_GkE)tT@Eq-cj(k6p7M(8J!EsShTt1iu4bjCgH8o(8IG1@wN8DthXG6iWN!d zI7-L`+m$mmdt2sir}OX;i*FOcV&eKFZeDgCEtco6jCX#pMjs80m(N&1Y99#)ZV6)F zK(7ma5f`wH1^Kc|7=5|7i^KMoH$ir8?=vS$ISNz$y2^+-Lr7cU0=Q!@+jmg1y}F8` zC|$H8X=_WSC;URRe}>hiLCO3W@ZC7q2(r}}8XSJfIp`ci>M>uOjEor5mNv?FA#l3V zM3n{Hjw7LyudhM9ldf+!oev}2L zv^5Lmsa(bvaNNvjB@1$@ad_lwx6<$74PRy$O{yH*tkSLRwK9yz6(l5zFILP(3}-14 z`WyaJpv4#A#!08@PdMJ^4fvo0*K>n2)fgl2XwZ2j9~c;w>V0!j;1{@@ zUb)_P>1oUYw_Ci}Em7HBZxX|nQBn-H3ox+m@4|vw9Qp1}1Wu*ZIdkdu2-)Jr!oi8k z*O29e(q|>zN7kUQX&xs$I^l~(y)R_G2FG0nE6Y=ERu$IQVB0frNs2)e{oYx7`dnE) zpVsAtW~FhF>ttP~f#nzMZd`6O1EZNr+cAv6t#47IWOb`zBi?BKwxu z>s_DA9dB{iBqsPJl^^Wdk#rct&xmPM2-G3efq zGtA|2Iuk$#x!$B?cAZ`oY60$}_e#2VlEFlWr`h{{!_^l-U&ZEAln4ZCt!ph3dN32( zE-EPr$Vh|pag=v|$tFJNNH=wa#%iJ6Xn2cg=yK}RzfZTj`JSWVuUa~q&N+TdTg{1PCjR%!ak<{hGJmB<=U!ynF5L=FDRek zawc$sUaHx}*Y;2PMD%@AmjKssWRoldSHuRXL)PqQx%BJacsG;DMRKYEg^hZVG?4~N zR_zOuTlrMF&B7@VHb%-CjGYgt9h@GoVwen2I31Rf2GUwwr_UZT*$k`t7pID%i)BYp z6LkefN=7qCt}|f=DZ9<;5T0zinV+%OU~set<0l`74t6BFi>cI_?_QmwGQInW>93pN z&7A=N=b9fB>K7Dyf6O&>O1VF5<4o#KNi0xdeuEGBjN2O>tZaY}eLer&l#1fyKv*MV#5H;-`5rA#kW!h5n3j9LN@Br8B-GdKMR9@qz&kpV;! z_;EVM_3!82$hVmK>u=o3=sK53;Y4RQO>pkco4A$TQk#z-$f%#~0mcD0`)XnSmhx^i zO~e`xAVQ_fDMXWRQ_7q8ij)yW+Y%kL>Z&X}naHR-qj?${8PYLp`(=>Brf*clQrU&6 zD7@;KI(_k0$XeyqExW=(o1w~<+YePpa1|9sg=j(_40mHW5P*T2Y^1XQ};(b@>r51ptB z@D-lP*~(_yLJUmQ$KT={I8a?*=@x7aK`4|IW7GBx7Uws988L6<&6s4(;sh;(o(5(= z4_M?zS25ozxjti!sn~Y(Cyfd+2hUck%b2{Su5ouYt(rL~=2dSuSMUD99`oH_t&$2E zniNx`1gx$?!&VEN#YWL8HmhOo*AF_olyiEkXCHt@FegU9!;Dk%s9Jm%ayCoI)ks8} z=*y*rda*1fxo=+Hanz>>2r-)XYGDGr4+*51+a*7kScrSD8wec;yMNL&{)+dpF z+Aru}_LAtC1eNqNh648QtH7r7opfnf&Suo4>55aKNYFV1Vpp`YYcVm@xENSqByoGs zn<$o$=X(Q-`JgIr<-964o85bfURUWv=v2D7Z_~9@kmg=jjoz+@_?NSS#0KgJxpDWg zpD#KvWnCI8>2LTJO|PZSY4@&RJAij+wgZPoLC|8ZUeAKz2>e>DX2r$r8hR*9y``J3 zwU>OGr~X_qv)Ae&KRP~-fO?tPPA%%@os#=)%BLE*9Hbi5sIZhwZl-u9VY}QzO~{@b z#bN!6BO*t4HG3?VcD0W)SkYr;SY8}BYx^L98rIn5>SH*kcvg9wZMvhRH+$^$n&xh^ zp3-S|Ewl`V-UrQj6a*dZj~_Q^5Yr*g)cmu-ozQoIFq;RKxT9X}_Yjb}kMNm^Wb_Zx_6L*dH=_%17}RLAYBn2)L+E zIO$lk5{Sc=og(Bi^O1^Y88H(-#w_vJ#lWJC(qk`vLMih_w?#Dec=&_Xe38_Igw6gS zMM=WOYr~N)11#nYJr^D6ujDPFfoz*uzONB3#p6clh`MeZZ|jE(=6)vQ5-Kl5GgFbv zlU-Ub6A`?F0n0GdK`x6AaOk;cu*A%TC0G2%iyEi)^4^r2D8L3uPtG0zcV1s&1d_Ss z*H5R_FQrk+B7|hGw!QZD-?${;7eTvKm^B&wp*pgvQlK6Fi=vw=BCFwWWbP7XWBfg4 z$^?86K_kBDQZZ!0V=8%IY_R~dB1t0^VPOPh}7 z+9KcLN3!SZ(48Ny4yo`ydO=`b8Rs%N3uu~jy-a%aUgey(ZwMMj#DLoastU`QsH#Jp z4nRc_ZG6YBY1E4=C+=vIjw9O0#?bzZO-rLzq92vOTfI4@RPbuKOU2HknGStYqVj;k+lqv*4yXkqeANZxT}n(biqQw9e6m0(T_CmY#t3 znCJTPI)+WkzI$|cUH8o@w>ID;p;j&Qe8%rCIBGe*R;%Wb_}+D2!u$w07ZQ7DehEwO zt|^^LcH^ej%1)b|y7uz+*I!84)$}WU+s-;mRmCE3?_YqH{Ng{yX>I=tt6gB+g`)GnjVj_cPespU6CrUkwI3x*Z%L$msDq+R9D=Dz*A4t$dr7?dzy1 zM39kj%jWTz-$Y5=Fj8B4@G}(0IWOp-I3`DKVO>_943s=8E7I7Vts>gK*YM)E;NG zUndkNZ?gKx&%)6UjJyeKQ{g=^Oq^zb^L!2PUTt&Rm2bZuOy0kJt6l*nh2FV2?f;rE z&p`W&egA8&|EIu94)-ILSG%8OJw0%Tma0?BPCV^A`Q)?m`OoAQCfm_x@-0GB(m@3E zqdUB1+W?Kj8I`uK;OF@X>pf}1wWfO4uZPLPIevb3vXu{7(V0BN2!&pcC|`IYs%2O zoR|%YxDX#WEQ*AYcx}!N%+^{eAUR(gWtq*@D^kkFQ1XMEX1!~y;Q^oRaQ#bVrC3%| zGJEhC%cp;`w4nMGlOBEnz+QCD!xr!FNpq1oD$9M_QwLiyVjC=3$NJ0L z8ip*z%)#d1^&{QW+`9MG=AMu4@Tf~Op98!Cd4uZTrrdux258xv2717&Fg)jxCYz`| zm?pmcv&L05{u2ZvE!YJx>#tQgZC8E<$5FmSe-n4t&u>#cKv=up$FJXE)`F)cG+uf8 zvU}uC2>7UZA&uAr`qd39zbg@9R6>ZH>QAA=^TOC1iT;!FZfLUI9Hm zzvcafc4uG16yLcmKkfh(Q!g#y#zO8kLr+S9`7b&MzaI{!?G|*9OQK&_FkK@f0n{vb z_K?El-8F$p&HDn|SUn~&_nje0GEWF)#3G*!_HTK7$Go#*0Lwb{HJXGlDwY%)?<@Es z`(L>2Dc}QGTY;}2=z(`r7Fc==Ga8n?Axz`XV#QHOT;wj%B` zOy=*j1c?MR*fXpm2=-wWaNi6>Nas`K{VUyT0G`m?6xCrLTXjK)wy6kw@({N~N+kcXY2r=tOh|T^(820s5xo8r|9*hOa)}z_3;V zE0{2OFjKl?+@2sXtj@=fZ!jx&?-9^ry)|(a%D>R;ss;#@VNNUm(cNz4g$aNTjr8fr zZzl;eJ(6aql<|0xU=Tub0DZW?bNYe#?%D;W2`tE602)u|BVf>gnFsAKXR5aqCi8Bl zcPUH?Xl#AwRGT=AGQg|`7$GzkKKie8A3+yTJvAN7D45I8p{q379>Vl^H{e|ga~oQ* zMxzfArs6ylog+T5Z?b+%#79kl#OGtz^JXx`A29(&JZ|oL4I{wcvaAsSs0ex|k9{Yr zdpf`)&9xlIsLj7(IAMB*>7~&TAp4@PZb<^Bd`}&a{+Qj?$KS0a*t`XD;JHM65+@qW ziu?jVM^C?=J04c0{uZn+0J5(@u;BH?bXtmr#lml4N>&41dG7uk{4mAMuc1qn#1HVH0GF@KE#+vE;ko}P8UtZy|zJXfNWGT-tFj@L$;-fRXm zG~}w6sL3RrD_hLg(`G4BM%Oyqh+kI&x0Jc6^vB9g`7``oUWvh-t&%F_)+s(=o6BYj z1v0GSUwE=4uS*(qLJep~J0nfm$=xQ04@A6U!?;z@{UH^li!$H#^Yq0M-%gggPU#ZD z+=n37egsIt9njPHH(n!S0KASpnBl*T5?3GJzv!L%wYp06LVW#($!AROQ#5Pb6|3#Qss2>Q zkFM@eAVBgIV7wnZne@N$UEnK<@MdEw3V}>4S34RLjY&=8VhRQA@m|VC`hJPUHidI> zn!4Bl13sf+_SNnU0<})YR~F|SFXz-?5I-HWA>Hs8x1(|T>G0XwzTUaviKETMYKb~V zNT>e0ISa#UZ+@caiNmOlIKb5u*|n_Sp6^yHyt!TUro>O7*om}mwmN7^f7@?cA=&Jq zbB#Q&tq#oXBqlOcp(iJc5&nNb^Ved9;ff8DCagOFE7gTrX0HulnGmrMQ;u^InTjeFSB$qvxmQ{%imPmX!!-l zk~2_<=OR()RpARx@nE9DknHpVSXM%>vSAhm4D$b)gr`6yDpVE(f|ELg;7Mc}hmFZG ziaq0_`mfYNTTeJj2+k$gOEuw-n9M*Z+ zvq8^B?9SH2&kg$=6)Hwe6>=a36P3>Xx#|_llci1?+Q1{v{y+a00Nq#72gb<~tXt(9 zT1=7|Xd;TRQGdv+Pzi{L3&Bk1w~)dVfl6S_42e)!`fp$)Y2&=98>W}6UY&e5cWp|#f-}O~y1H2%@8h@6lS@M^J6@3m81@--TL`ul^HvVQeD0JD~02mvo{6wVU+d~ zdQV^=Vc{7#0x8f`Ylb&BV;40v|6URi29Dkp)%pr1uldA8V;%H-I@M6F$# zR0=tzif7}`>ISaQ9P!Qd{o~7~O{4Oq!eYm0W!CV)3cgu(-XMzP|SNvAv3qs9*-y!@6%Xbaw zY?Z8cz)UJlHtE%>3`>S{)n9LnWKkM|M(x7Cz){(4GeHG{b%L**}K) zL-AM(M1mSy18=i-W?kfP=+z9+)y%W<83=^5*+={e=rbSbxow_kt@G>W^64LsKh~*4 zyEZ~|))FHGUAmcnHCtV8YVkH8`k$%XApyrVzRw-i;%If=ItB zmkkJAiq$$<_ws^xAukh;2yzQB*5|as>LY}8ZffU{&o5_h)AVX^AaaA#uQl*^Tt7g! zNOg7($xqnS#xrRQg!j5uq~{_OC{VhWX~*=(zjqoo4$RHzRNE1g6fAYo6Wbea7vFw< zis|I~nD^wblWIyiK<;<9TMn0hAvXm$!H9Nil>=|zdc!k%BZv4CBhA#9#Vh)D0|*qj zNJs>Tt1nIuqoG^+;JP=Cq2!d~PGtIALG;=FFY&~LZ@nZ-lgAncGZ{o!fZc$9Y+zYO zWJ_hf(3q^pWOSp@dDzu`pnDm0k-_bF8^-V;C@RJGP%;k3vOCe^n$GP(AeJMqu=>=Y zT})$Y=KJBl?$2FC0Tk~}OXmOEzj=V#*2YyOJHY?mu$&Hite4rf*nYdA+xq|5d+VsG zx^;hC5ClY8MCnFax*O^4M%*I8rn^%GBsPt-NOyM&(jnd5Y}j~>OCH)t&A-HC%-+byHsxY_{fpl^%Bh zwOU{GtK5}pxvJ^2t@!2|p2%(yN?fc4&2{QH)!~YM&hj>UR4D<#a(pVZKUl7;0NCeI zb;gOW{s$9#5cp!6f7Q(GrfLmPLZE6!)}h4$dQ^9MS2ll<+tGfuzl^9Wl>L~?YBrow z8e6))+Qu(;?U)lDVlZ4n@%!$Wt9P#8xo#)o|Df*{4gss&gqAngVMEx`v>VW@vmbARXFG_M1Ly|`jT zKS#uNeo}+W@yF#e1h8lW>=Xt4AKd2VQ$V|4%n2M{d_m@SmG21sJqzKeyJjn^R%Cd8 zQSpDbMZ5>@qKxOdga@dUd(Um@&Hi}7jX)T0a2)n>{6F>=Aocd%y%Si2+tx8I)_>`* z;PdjX=f%x4&ykFTtK-x8i}skl`Di+Ix@pZ3nU0VYQhx~HXjLqowkWUTS+j*c=idlC zT)+83FI{`MD&u{~R`_)k58(XmiTD7T7f`|}4BEAFfDfe2WZ1~Czw|SbaI#DmNCU6z zw1-fF+MftIuj;A1!^_r43vCO)663Vc!kJWzJ``(SzmwVw%@`5X<^vB7bbb6>+x1+l(gZbU>%zBLp9N6F~IyK_EjeGQM!Yo zFJF}#Xn{sM*XXu4zh&ut3LKA}oqUXw5d1U=^vFzke1g2S#O5^V7Wm)8{Rf|cDYS_!?rldP z;~hKUu2Kk{=t4S_P=NZb7)ganR_f|(zt7|LZ28Of{B7D@R^1lJh~v^lMFJV|uhU6* zma~nFZl|!}{`Fi+nJB3*PnjqI?rDrx$y;7cW1@fCN8jTBkpyu0NGc}#JuknxQCz+H zba((QY6{$%Wt5I+yCYcBs@9eRd79?zOrcBey=9Tf61!Liz48f$6i(ysjfs+|;;Wrl z+#}gFgMGfP$p_HMGTW1FE7y=Go5Qk$-(OQEoy<^YOYhjJxk=bvU!Zk;Wl6iyyW{hV z?0mO6Tyg0=Kg3%Z$r--z+#Jq|B!B%FJP>sg-s%t88t@;=lx9RUWc((C^!TJ%O_=mC z3WL^JlKpLdtV?@^*;tqjNYZrR6;8ad*3DpiPsp z2CmZGvCLpgRa6MEKm?<1Wt?#|z2?w>deStI>-~8f*wiS$gU4m5H<={>RWD+TDG7V%v#ipAQGw_ESm-{CnkxUMOyMPJP~h{XX9eDjO1chOfb3N-P$)c3qz z)vU2S&P|tzmMJwY`bj18H1;b?>j@8+PscYH^)x23E^rKtpadB@G<(l8Eb(Z9enafX zT<^#H?Z0$-0qWohX0xJKGmaR2K&t15NS1NUa*{2$;P??e#z#Pxx8W=}+s!Hch9tm& zfKI1fU_kvmpcPM<4b)VZ z{n&wGm&QWkl>(g_y)7>1;l;(Isp|KmwzNv$yvtpRlFVmoXJ-rL+-CXa^*U17^AMf2x4%Zle-7*po+*M?u zZH=>O9M?Q1ulz8o(VxV(t5m2lf;Zii#5c@I*c{m7YuR7*;^98N`a+=oo>LQxV*7-_>EY?cS(dD2LMFXos~RVN4{Ph z!Dxx5s@OFAwiox8EoY6pB8=bb*C8IGjqk=XvovLxqw(inY{7-hKI9pl76!=W@Aj86 z9Q$OXcM|e@Vwh}^3vyEpKBJMC>dwC;yjUf@D{BNr-xpQ=-oWB)a8NreMR>>@Ka#RQ zRy30;itdcvlT2=c8GV?9+Ru@}8ch>E)J21T`@_9+~%@v73EBmX<93AC& z0T|D2)2|9_n~&slNLqWbX0BeAIf_LMOPLPVe>!@;S(w$z^ zyFLo6OQCj|g5btp>hy9p+E$~bR+UbvaZhf+ryKDFmLqvnET6Eu+((WYd$!~P3;xVI zravhoYYM=$A#Oi!xyg`?H6C=5?d{g(EEx7*QbL5eI;)9=W+R!kt7XU-o8DNmNyo6q zG3b_vuJtEbnMX{Py_c%URX=iAZ%(6A6I070ON?Q@og;J4sm$@`V$@}irBS@WXYvwD>efa!0i%0>t zzD}+$_?TDg`-gfD^n+urvUI~+kxW=8mRN-eX~xRT`Jt=#Mq6Oy1t-N(+UHm5V#9?7 zWf}k-Al*uJK%z03n7dYDjUn#HV7m8F(la$T4)8da>~zDt#2w>?gvoU+pQm)`QhlwG z!rv=uWC}CKYzwd^dJ~#{&5Y%(n_PrdIPK1jy0Tx&5SU#A)a*=z`@Ki*o?d4e+lv}3 z#-~kpuPH5coONZ<8{x!tSLt{sN}7wB$nPR!HsU%bwyak$u68WPk)5NSaB6(GR^W;Y z{-xBQF#`VeD|LOMki;uJ#~$Yjm!*xz$I8d^&U%VWjHfGiY!`pLcG+9-3C8D<0|`q7 zTYR=yMC5^Hj$jDl)_$}6cKFN1L1s!yih<@Q40SCDc{*SgaX1&Y)>xK!}!Z58}oPO@|2!t zOD>%{7)WKr9+i^$AxY)M^a0*~${nKQlC6Vs=lb$n@>FTiWdW6V3_5t|lTBCb(V^f{ zb$;ljtIJgsJ5ytba$tLb@tlFJF*#?v6i)&d(YH5$g1fQ@d@l& z{If{gej$vc->2h_>s0dgbuXt7pqVD8y$@T>g(seC7)diMKes= z#;?-#YBlQd0FAn?vXde&!bIeg-Ic!WHe>wud4F#e%)J+Ib?fAFdU{gHe%z;fqm=+t zb7BvzE0zn=_64_R$EX2~pZ8Qe)74S6gF&M_n^Nxib9Z~eY`fiPq?6qkz_RN~ol5Ug zUCBf78Tg1lQba?icT7G2%3q{)AO%}RntAL@9S;?H&{SkAjtxo$v#ueFbHL$hfJZMp z4$GZ(r=D$xwLN@<7QQ+B(9NX$5pkA60-4_W?hh!V|h8T5^+HFI4 zog#QEz|t`caea%W$9^vRVra&mTSqUnbI~-Dndc9`)!C_%q44K|Ez=!D!wkWaXkPt* zpO^~h8Wwv(kMFqf5J4M)nm@VDW_rNR?8(H)SI*c)iOOJIc)EiGy7b{ z0NUGe$Pf{qW0&Go7``Ngs7m0C63`Mx%*WLlB|s@Gt{5>QqelOp);&x123DG^Mny5jFPk(N-*L=RMNAhsGV1sr z4AXCjU8ReAO)y?G=E~M%Qds6KtoGCz9nY)EIys77 zle$yZbiSnQxd4;SZ9)C1Cz5uPQCefs@g!I&Bqz)<*}W(}?I4(lO_bz7Fxw;80yxI~ zhANs4qP*$HRdyy*Co&s%t9eR3;9an8<-lGzFbfVnbl^D+Fx}qeKRt0!uK=Ny=>UZv zzeZ!Pz@xcj4i&_%qZ@L`3fC7H5k*aL8K>RP)iws5A9<}F@Jx$6HV>r|PpD=}9`<8*ieJtHF#HA8lOTadr)Ino6XJS;f~!69x= z5J?$mI`V8*2x?3qsy3}2U_3W7sZ#H(T#>7I$K3DVs!U4LD(r3b&?^qs#A*I_lnorke}d16*gpp?)qy#Zfm3c6x*o z%$X+b^*0N1vwTOyC`o?7K&d`eG`+e#kBZb*Lnqt9LjOFlOm;m46`n=$djeza(`bubj#r|p(smws@$}pl8rl5{NyOg2x7YH~6;EDZ$D*Wzh z778)f4_jp3!pL{=g9o&=YGixQ^<(YGC; z7FB_)e_+$+w#b>#9JWSOO5VBz_U*DP zeu2F0_CA*;jX-X0u&?0T#R`C89<27!qvBm{C!WF@YYhp#v;*-;RF@<^W&xGAfjCX0 z)7B+VG<#AJ+^*d`e&tOSIJ{ilwtL1@j>q^Fs@gj{4kmM!3*hLmIL8|MU_{2Mh3uqX z0R`ggcBR&X& zEvV1U40$Ga0uC0xP>HgrgG#&)GTM(YCUj!3&O0XsDTU$x z{iiEfxOo0`z4gaSKIARmiT$=NoCsQw#QJIvo5?_Tf)#r7fFKE!{q%Z8IyAat0-1Q9 z4`n7eQ)*wxLSX2~=pc$Vv>40gI@v>_)(J{JU3p7gVK#1eu|Hke7r|+PZ$d(VIhQVF z(*VRNx&tA=QdByBc}7f>J|p!AVeSQs${hYhC7X&JF)x-T=Nt7(mmq&a`p^J_GP5|) z;6Q^!zJ}=u>H^S~<%DM*34{2hi|zUtv0J7>LZNPsMnSF|;q7Sjv$V!%j5^=-=|I5l z-hfDKesq!yJt*PcaNOa)+QDKqKMTl~8CkEuFwK54T{?Ue_vo3R3t^p&i} zWwoLZ8p}zmzZz1nqJ>6f_M;9yun+#n4Iz0b8LcjlyVE1{`6y%I1m^d#&YF4l6lFkj33lw6LzX&jv^EL_Y z*Dq}RXjW&D{EeYXpn#z|uGso!KqXsAqzrmGedB?^RN9olZh(TTx^absaYKb`RkRgF zbT-v9luW2>??`H z#TD@aE+1(Wmb+MA9kRGwHEgM$5(bZW&~tuxyAj)&vUBQtI8A?0ZZWMh_xuQ-(_y0A zv}`1Aeqy_uqJShqx49cg3Xg&Ob;Y9M(Z(}=mF*9z%bX~By6{i=4Rjj=a~&TOWJD7)(!{}PhRaw)#4VlK(*muIvLZl^nusjYJ&Q8-Itd&uC3 zVmeb%fajmC-t%mVs@E40)flMMqLvoW+bEc8^B9_3fAkw8{(uE=A$&mg=9bAfhqCU*o+}(kMsSR_Mg((|)U+mkE_o z^Pab}rnj)V-6(VIGBf2A?Z~jR8#juT8|o1IMxj#}khaO=GwyvfMqL*i*regx0jxEr z)r~r=f%%Ky3&S)Cw3V3}JKvgeG4t`!!}S5#$%86Bxt1#9Af)mIBG9en!Ks4XNj-14 zk-2jqvBe!a8wnd@VFw_>JthXhG3VfBEU@JCz3dRX$IsNe!<`U)-P#x{3s&7q*vH9$ zTrBn?=mLa;V;$3>Be=+?I|M>)aU_GwVtWDT&8yvh7*&B|czp0e3m&{{6w*n&6-0d& z*rag(_T%$TwE0G#aw2T~>d3Eh1sAqU%ICNp^(X}9)JA_Zb-6t}s8Xe1L30kYa2T9p ztF)Y5YcrylkWI7}n5~ts`(VK5PN&S*;OZD_a>2ifbA7_ME8!M6O5-**yMnTfPi$y)(+v-Yp)2vTrg*UJ4V)*AK$1N)LX)4JgZf&=-$h2=9Vvnbsf{3AG z;Ow%#WDYSGUso-K6hTHt9rjqK&rPf9i8jEYvXKG+m-}PfL>>URB?F|FiuY@>_>VOq zn!$^!a({?Ie5+U^w7Ivj9Gdq*cP}8`DD?r8QZS&afI&qh3nWJYLHVu?h|udO$DFrw zbcpySCs$0o^aSwjtJZHuYJ)x=VnsUwFX~04J=-v`(7-* zUcOc);e`RcrHW_NfqA=mZ<~uF689nNLZK@qdedp@+G-39suGDOo`;NC1-WKu;KA>4 zj&*vCZ*jAjK%1D?^eXvLIJcv*DO~~_-*vw{;Yi7O32cg=L9yMx7Of;NXJ5qFr)-Vt z=c+Zf+7GPrB|12qe~D&Q36x!@A9(HPjk@o8IyQRv1uUiaNcRZYheGu8lNT=?gJnDO zgAhbXgA>2jhnRD;H14p4|0TDFJn;CHPZ$)Y@M-B|N27L0}AGS#nBNmDxL( zU%jO?=_k}V!Y=>T-8>HxO>N_+T#$XhoJ0bY;x&BpRC3E`;lWegW!IuXzd4Rg6m-zB zUGJv?S_d3hv<(n{{EUQ7_%zCYk9WiogG4a@FjFyQPO)zvCkYeW57;a#or7r+OBYWg zm<E) zp|tnaeLb0i=3cnKR(kT^%H_X`@Bg;a{Sy4QBKyCs^xul+FT3ggw$lF}w~|jfwR4;E z^ZzAI7Bc$i2CdXrqE(w^Ees-3^6aYYeN8k;0sTQIDHwoTaxlpU9e=TU{~j*?0i7%~ zfQ{4}S0YY$2f?AjrTF*wDD@E`B7T7dO98G zf|9LF<^l^(A7_Wm{cIWmaUHF;2;ATOUI*MG{_jtHIw=5gt@KIz9tZe#AczfozE|g@ zEhvDhSWs<7|KFTu;5!Ipz`ZbqyJ+KlJ671I3F+_m_Zc?eI>sWM{wE3jMSYS(081&H ziw0$k0*Ea<5g?%cGjtz>y9M@DgyZ|Gru+}rz!D-tL>^FOy#tKqVRO6u`}JOs1xyx0 z;u(rRcmIzU0sMEi-CQE276jOmua3;W-Y-3NBJdOxLB#Dp`{O@f2x9{G`oE3!pM~`M z)BoF8|BH?F0Upe09$P_B)#E1*mc6hyC6DhuqqSQFIsy76{X!s=IDZ}gm==f^C z#yUoky1+7qtPOX6NGWyhU}!1_)Nv02e>s$Y&ThnWpUFebE)q8knd4mJj1Q^xSbViW z1fbW4%Mt=`SfNKsI?&5q7+uZkq z_#3Pd#-@1X_=DlDooE!Dfl{s-9d1e5C1}@>)$K-Rwuuf`Ryqe8k)pC_`#BI39J)iH zp|~C`$VcA}EsA%D_vbzA!yTf1$O0vZmWG5BNtUu1>N2+SI1XQX8L{^@^*QPKg; zCCgdH2N;LP0YD>t+8v$Ipozgg!&(K;`5Mhr=0o`x87{3`Sks!0!3a{Mo0x!3+w3*Y zmlSOQTR&fAu$F^+6!r`}t8@rAmUTD_lSpzMR-g-g2&1Hl|>1n|-3#vLb-!@NU2M zPByKsna8c}g)bkx8J+@|zxY|ZGj})i0gC|p1uVi5J|^7)B2VIWOt=T&C2wF5HV?wp z?@XhXdcfWfZ!tonbVaJDwgQm1E!cd8gEI*)fYRoWc3(tjDxAMFMz_pNE6D ztsfxr!Mk}6DjLn80ne@mb;bWV22!LYcP2(j-}6h^d;R;*^$v_}HeL<2h0aAruvo}+ zMRHgy5h1%N{QerI6@q!5zx3>vZ&>{JSVqxbGSbxoefQgWsnJCCzH-W&(S8+*HJ>UK zBd;l9d4YEbSRLY=cmAH6=Te0eaE|CLIVFDIOc);PH88e-cy!0l_wxAXFo6uo>U3!5 zGDWOZWVg#|1?Otykrog4?}hTICMz}{eLq=m5nGt=I$Ekyt~6Jj!wnCP6Yz?@DmneO zOkL|9_f}=G@-5c5D#!unNALEQ5CSB8YTSBpXQD<{qfn26fXgz*0m>zFakQBsdOn?Q zzp1-g$d@P69{j>rqv3rYuexJozJ8Sm(8`*c>I+`Is=~9hv|g8E(WFPP0D7oF{)qIyPgN>Xh;1+ zMhiN?y6)@XyuSt(>~nL?;rc2>!0V2Gvw8t7VjH{yEDpe2%p5SF^CIHSbu;+a*(WD_ z{Xw4-^l7wB-|a*;X9+PwCPO6^H?%{qa-l>#{HpZLrjE3X9h+M}|EACaN0YeSYB%j} z=yP%)iFeR@m{MwX1M9?Cfm%_!WKxu>_q;z)E3&MYIHzhuz}}-4Zb{>cefL7P1yq{o zh#r5xn(V;hH(-2>G-2*uu;S`o?YX6SZEGCX0sVCHY-h<3qibZs-EW* zARlhZz4h=WTfR5{~DvDsbwKVWdbCBE+)sc;^qCFHxE|;@&UA z&ohIE>Wz+nq0+qR@4>r?>AAgPq-C2Uv}Nwql8t4^FQA@_5XfWC)#X?@*pD83#y{r> zHi~2O$`Cg*1a-e#N~dMDpQuw{(UX*kc}ab%S4~Pk;$YoW+fE8peMz*t^Q%0@J8+x8KT;6*^U6mJMBJEWK?u1V{t!G>t}nu0yw<8lMXAidT!k-h*{@HoieYk2bvTNhchoy(q$d|dWoHjD67_g z$RqVfCm{_;1@gze6K%prk5uC991_ZCb2K<3k$#tzKkXtng=Uz}hobq-8YO;4bO55! z$t)wjh+bw;K+jW_ZX@XiBN04@5GwsJ`M6ZWW=0lZA|dhl^@A~nZpW0|o*@ehEoAKg zgor0_^>SklBdm0Q(PCfBa@xF`{F({5Gs-C zY;(ANTJv+eHEzY{&A+lB?(N$T@8ru^ZBCmo}c5nq~7Lvx*^9Vw)!`u&bUjAp{C5sC(~J>yL4=x9_8Qw3G`ox zk_s*0avRtT4^aM5RVW}Cstdg3ieWsPN<$W2+ON68P$4pb)i?}?MiB}pFqUc4hOxbr z(^|SZ%v785Nw=PS)7JlehRsz}jqTd@yh?+aivQxl26>=xgK0v?J{P?}k zD>lW#ZC1N}Z0QuH0{)3|jb_{MWap(7>6$77)vScp&*($2Joz?&r}=KB6T|pNTNiJx zaZu(^mJ>!~ev?;RlT`A~>GwG%z3Q+hZs2ck3b^3DUl}MKM+)7}%sP_Ym&TXx!o6Msz`7hvwxYHH}G374ijgzkoFb?JpYE}v)>0e)YlZk`* z%u`_|=RdSpGW>hYQrBuwZ)M^MBIo_u0j5RQ(CuRKL_g{+Mc{VS3X}84(HxnEOsMpa zW4gvmm*2erT-3(trgTPx@R&P32oUf&`9Ddj*B)of@M5HmqB!^o4fl9=aT5AZ-_B=6 z=7Giyv71ximCaec-vcn0!4H;s1>dP`L)xk*X1XFOT7@PSEua&*94fnuyqFbhX7G4O zEvai;kI7`zXvYe^b-|T+|1Rs6zXdw{9y+!2$Ig;vzM!PobfrfcFAm?yX7Nlj6O`v@ zOC_5cOy$g*o6mUY@itYB$U z;Zj65o3%i*P*3_XE(2+nLQ;%N6T{Ph6HMSm$K(|AM07v`=an|j)#Y8y&Ubab*$%T& zx}Is7s29>kJuwzTji4yZ-1#y^*|N+K@*KBqR1|SSIAmh0{upg0{R_Exl%%}Y5t?Du;R^;#y8lt*Ayh43 z)ht-<%=Sk=)cFBysRR?1V0rT&g+=ST5iOCNTRF}R`iQ2^ZprD~jARg6PG8B=BM47P z65fp@_9ShW{$91kF0Cog8J>W&b>x*T)YeG;IU>Z!2(QLjraS(bE;Sm`)+(x384= zAAj+J-zKfuffZhSJJK*4ch8DT)l20<&~}T&2lrj|cSnCE1PJ7bJ}H5dWVA*4je)a5 zAH?DlRt&*3n&C$8Xg$}~Yd6~B(S`H3`C@|BCZ3zO3l^cH{gGaVQRr68Los86O@(N0 zM$4+}@@62I@RFg#k&ny0h~=kkDzN{&#*{=ZRzS&CZ(O zGTlk1l5|pmw_@UWC>DRErH!F)0P^j`Wo)koEGJKmfht4htk$gZGC>Uy64`idFo(}8 zih=vqC19=L#{!vE&q|l_(#S52SHXAn3`v(fTSoQkCt!}ihG`& zxSxv3(?+nB&igivNy?ccK;CV7Ibu({EP7FfCq>L4LNIOk`QP~@QwF@$nZv#E2_Fxh zT4!bCcg6amPlyO9S?(C3410=vXD!Vf&OqR++A&ELHk=^oSM$fE?$cO1un9+}CdUpI z)1r^o$Qa`qGW4DP#`M=uvITaz~_O51v!=piC-VHq|y1nRT zTMYyHrTF9ngW01}fJl?*aCw{F^FxN3pV0Z!CjCh_DrkHoos5WHy5Vt6qIogwtn=5) zyaUYY&<%HgNQJ^Xe*1&^ncFG7S(+oOlV-PLn?Lo2 zsO3qbaA*|FM5NNSm4lyuB_>J*UIza-O{y6KXp|b-6+9_hzQ9sfdQffJgMQb0N3FWx zYYH|BiHGC-`$?8fs+7=`+(D7jXz&KkdPU?f-wxwE&Ym@kI!eQ2LY1n|UPYXTv4xTI zK#KvoXc<|csNJ~#3fK0m)5cV*Dt@Ii`6u{8Ai3p9qRWt1Gq|>>sQ#*cMzbi?r0G)N zG@{ZmxUI%6Q}*IWbC(Z~Nrx_$$skHDj#cK<<2h#2A2RQv&6H1dM|TUUt>ub&)pefC6s4|yCcR5(YIaFQ72(a|rROQ0eJ%Qsyq)Gd<*Y-zq{ulNa2 z$gs)%UN;d(Wawh_c&ZEO{fO?2RF+xkqpZT~qs~#yMAkwj7F`q>3-!xF#Aw_jrAx5| zIU4?)QDKj*Qi5%4dX-PJtGRncyQ}QQ9J#uK9SNg3w&2!6wie$H&b-L5tkD~s`FvA< z<1O6m_iGF0>v>L2bUjtMOUapWEbxiagp#|3yd)v$2Q zoLIF;NQq{o?s4TMs3(PHHLK!sRdKa{_ozlTUJ>gjw%l;miR1G7_Qy`{J77F4Ee^4! zJ)uvwkt$hw3NFR9w_F8-{#dG2oj<*pd)_CET{j@7uIbNfS{>5-6`%nHRo6zfGvlLz@NDrI?`b_r4 z6Iqc3j~@9PD#8{JH^U&0R&~qFZ7Q*Fijszfb+4%PWBP;}J;qw?Gd^m+q#oEIt3N*9 z7-BvK=EJ8NOMd;`xuFf2lTf5Jl2q%^Cn_ohB;0G}c#%@A_&AY=q=6k@a#>jAMk#zaZBQ5OUsvO@LEXx*OgTZC=T>7IsOw+4MR05=+* zWLGs;Q8bYW*?*em@qW^G6}|*TlLUGnET;r*3H<@_^Q>BWmKo+zNts41KA{% zkGVBoCaUXFiX{OrFBk$(y>MXc%qYCJ#?{F)KeFoqKUvh1Rl*2m%g?D+_(ZV1yjWaH z8gtTqE4_KewOIkTTvqS2N&V~nBuw?VlF`hz3gSjq&HZ!V>ukiOM!I0P+7i^z?n3ZV zc%n=riBHSKiHM(qE9VgLR5iqMfMCa z8rtJQ)KWn(u9V->lzUkV9TiF0T`S+3`YKDpXK-8xMLy>x^t*gDqv?4Bikg0#xLh6U zV3;?^l}N*;0UMp|O@+NCRz4jp(O<7`H}BZtw$_P9i_c0c7Cil+r()%XLL9#L0}s4% zbS}Fk$Wc-GIGZgGqJ#+P6mn`6aWOl3tUpp|1`{-}&R^!%{;sub70vL%azxI$aDpuJ z)P|&ghT3H0Ii}9Il2=}K#ZRJb9x)xoxX(vpjDke+@w+EaT zk=YLvyLSTb2r{0n4Joy{g`?FXO_{Ngd|d-E8QYOji&lS($MiCUU^Mp0i|_N036G+JHp1d} ztGLgY4XE?R^M|Ep>l|VLLQ`kAI{4it(2Pd~#4^UB+$gu1J&*mEE_N}5U>2`{H$Vj_ zF=L|F$dB>3MBg|P{q*<)st(6)jqW&6K^X3S2Z@`pAO3RXPE!|b)=P?d)t4i-RATJg zO@oTC%@eL~hN#igV`v0id7eA5s#yacJfEx1@^VnwttG%~p!K{d^Gu|`>?7nqi%pkF zlIf0ZkT)Bzk@KSZrXzL81dV>H#JY0|9=PB#)%>es-*~fN$B{|j?c6}&xxG8Z$S3oJb+H4sV z!qHPM^TE-}Z;N&Rl4mN!sZQfmx;tvFiR6ME8;Nh&ggLqiok$&)KPn(Stm6r0Ki?Xu z)=xUsjtE|`DbneQ7upLT<{B#{*SL8jHG*6<4(WaE)}40iW^0+@b(RrH z;S)Fa>KVJ4jawu|4RuSLaZ^p#H+-pvXhmk@Vy zMSZ~-7`bxi4W!TG$qT{7WdF>hH{-c((U{+hbn31G9pwdX8vP2!4aV^kGBg`}@|7pg zr_ppbkehd$%R<0I}A#bj6mJiJy#(P}6b- zMHkN!y*e%8S5XM6TTmIJUzqV!4TO-c1xX|OgNs3J<+rW54gEE2nd?bgt4S|4I~-jS zLEI1nVmt>S)9(1)i>=itO%hrX3VPcU9n?b1Fi!!m*qottg41`^T+(SDn;nax$eX-` zYaUuo4)YHeU;Q}TYV2o>d6?%PWvmx)ifOGco&u`t-|U8W7tVhy>xqo%=QScA6Sktb zw^2lQ8NawXG{s~Rw7-3+ce)R}Jj06>)*U35dBxTzi+Xb+CVXQJTi#O{(Ve##av0HI z{_Ro~e zdF{2h+y(?julr4kvM#!YjOpzgS7q1F`_^Gij7Q$;d9R8-&j5YmWS^|iqw;IVg|s+w%1{|tJMs<-dSzlM5zYge?*TNs1iL*Qp{ zAT0#cukzoBD^jV=EaO-?zG=w=LOtNqH0u7F zxj0X`xv%2w&}xnPW1+oV#YDG`06r^?7zXG_HHC=yM?<-YR2N5D(U4y>1)Qf4T#)R7uovmXBPcfTf+{ z&_9o9G+QFp!6fsM_!z!(VnApJ-qGuPc3y4cDhG;1G$qXHilsX!Rk-cU0Jo7a%T8CcG2V}B-s`ONU;F|7ucHiv$y|NaXlQWyKEGP0M4H9UISA!$UG1Q z)=jKQ&NHkyf&|qpc10|KpXnkKK04Mes!Ojfz4(B{kKFo@1&6f1Gew|*P&r0)n|BtY zGHl-S8>%eDWuew*`l5XAmZ9hQJ6~-mZZ$n%8XiHV-H7xwPJ)LIzjNSJa~!(%TM~zo zljsGB=>Z*&ab^XzEFF)ZlQHmSBRCeHfZ&PWE*WJKncKV|?th_xNv)@ZAqJ-J(N*MX zP}gm7@sfyI#Vr;U_5|ra`9V^xS>b2VfUy7d@NM_ds-v+D$}=swJy&P&N7=8;2}BHn@Fmg_$vyo#kIEKW&2df2fng zcawXY${|2li~=wG<>wd-duM&*iL9C4^@YiVK+6YM&W);a2N@JUxyr@YUVBXQZ-WRr z$WE|=7jU4G>!&fiiD8c%wTH4ILfk?x3H^i`9E(;u6Y;g*x*N2eaI>tkKz#a9-L_fu zBafPW-T7JVeSn(Tu{;L>M(&m$suhBoWLd`bBxfIcJ;4zw{8GH&*9 zlQu;)nB9&WQT~ex!>_A$=F7>b&`BBN&AypB;bs&Y9XZkT89$#-JcX|~^TpPlw>y(k ze|CNX*Flv}Jbn5tz^RBn0QKpQRs4OekT=?DGBl7wN~%A=HfOE3t8pPa$hp)9^JQ_ zxk-?PBA)$*jG8Hw6@z(wW^WCozpxJjbG1A z|M>2KagbJv)U|5#S_OEu5Csz=q&VulH%rrS?bVVtyYc+#n*y6#{dcD*(;OGCYxp_@ z+G!eK_B3`v;h1MYRqW6=WmHD3x&k@cb1jq}QMAerm>M~6_A%jNvilPSpaGPa3+deJjZWd9g5sJhl)>oW42E z&+bS>f4Mlq=I>7y&|JH^3i^Lcon=&%Vb``5K|rJxltx5AN?KYsk*?D~{=s?o>7VucXoRG><-J*w43^^P3Nvke{OShCVCO>L)7v^_@A z9r3mt*gY$NcHp1P=;da}D-cIbD6=**p74t^=uGK1>v!)4^By;CuoL*piPp~CJ5Kv4 zQ0r>+mV-xle1H7CNZEfLGuVB^w!@G9?qn z>tQj?`TlF8zn)XS-Xl=APv}i1SBa@VHYLzEu*4`1Z;BJ zNj7hN6f2%9{H`-sxU3(v!4X~6(0Es-URFLbk91hAY;ZlA8Y&sF{gdig7Pbh}ui{zS z+T_CymOwQY$71?PPE=!={JCBIe;Nz=zs4egYAm#|Jjn_o~Zb>#l| z<`T3r5Om$t0X-Dja?_ovW(8#b*@Ms4<9yNA^7--xO)SU5@nubh9sRIxb|j~xhd{BN zhjjB(&E%kd2S*mlcRo>`Pb|@Te-s{9TWWr9F?7Y$I_i3+iw>1awWCG1+Vi3}Lk@&H zerjAX)!;{aqHFu}zOnh`-B{UnQW3m!);J6^AHv+U=Jsh$b_qZFNa(W1Ec`{Ns2kWf z+xqN}Ff7urVipW+7C;TU71F}FyV-ts8b)$19=z!fx#_@r^ah*Ne!Xk#qgB0yMC=?8 zn;zaRSPu|U_VcXe)GGL`6`uWG=(KX5DW=#Az#1W;NPRG2sX={)>1?U2!Oz#6Aeony|pG5>$HAe|^#lHPD%rLDMu@*;lmqNKuiGx>Tf%<2mwR)jz zW-WFBM0;*c=&irwd1_3C)vK}BDSj80BacMbY5RfN8DL;F$SB56s0}W9S&AcGj<3iZ z7w1&;vJr^oP)=y<^R}RTvPFV%SIQPdth!Qvbo_6sS7`IAWObEqsjTA+5D(yI7b6+& z0x-^*1=~k|AKXMl?AxVxg4!DX64G`B(jEA(O`_{AJ+%p{7O)Hy=56{kbb@^)6s+}B z9G5OO6l2lcTAte^if%aJ)Wuq^`tYYeDcU0B@^xN{ucyzzrB09l?TR=xVYNa-Ggs$I z%)T_^Zmpfvr~dQuIrYt{g$vw)FObka%5`Qq-}ADDZmd=(mOrIMlqO!R0T^alDqsJ2 z2HVINL-5*S|LQD*lQ*Ag^k&*>b+>eE0R3b8u?~#HjvqdH0CXFh2U)FaG15Q7Y1vpR z4W563=y=7%;hiQ@k}+wP?hyxn&ti=91A6qLH={_`V>h0pn<3#dOZfMw5wt1m+e&jU z#(;AEM%ukTp6;c{-rhdz_bWkNseIQoYb!(~PmYWtOB_MZ%VG(Dv|pC4j?Q_G4xcvl z{HMc^zmz%&zb62R4O*aYBqyEXxCyd(##t29;@QKQtEn01Z7PN^WkFZ*LpkozSWAr` zamyAOy^P%{A1ZsCoTzyXmc9O1e+*>h?eTcY@xC|Z^9OTA<*b$tItSZ1{&;*6k;fbN zf5I6C@@uglFKtrb4P8T9i`7*>4cM_47K+#&RUhR;nvI8BO(@OG2)jg9szI>#4;le~ z$)4_;<3=3$q$8WK;VBHl?w~jBXBpCL0LkTm-dOjtq|_6%bip;>>kd*2*q%~Ipc6f? zcf>0%9%@&oU{djCwKtSpGEd$hnka2UC*bbnOAcyNsPpEaVI1@0K>gsmC$yC404$CM zBFo6<${o4RhQh9cHahj8K3W9_%exr10_(Gy2C*nt;oO~L$jh==x)tP?V+ockgr;eF zTh0qAT)Z}mgYWrQ ztE&;iWkHn8rikM*X5m)R^>7uMPzprX8w)(6ki(27Ou_A%(=Q{9i)f_5{M0d?(1F1D zM!Qa{N!qinZAQJ??jyHqf1WziqRJS?*CZ5PZpXRkAZ5t6c$6nuEdT?B$NzjMGA-+{ z`3&is3sXg7&c!0Qb3L5b09W^m1V>eM@XkBkM1OA5dVYS_?GO0@U%L55g5{eDyQ(KD z{EDpb+Mnt?>zl7i&^@1U^$b9}X($-D*v~UaoQk^-|AuzA>-SN5POAO0)?r+Z&ObkU zclYMc-$e!5L1f?W(`frQo4wZ^7S3cyyZC~=TGBc`Jj!N`5nlE+i-XVvJA9PK;q9LI z!7Pv>IaZXmVVLe}meG%d3ih#S^5zWPcmKwkb=`qd&{yZf0 z4wEl_nJ3o7-ul#?)|mvyRp>4iogXjODJE7dzB+~XXLMoA`(yN@5T8S_Idl|V*@9l% z!wDCudd*5=?kazf)D~ltCf|Q_FW#f*;PkSIqfbYgiPLx;D*DzKMUU=IQ2^4J#oh5H z;3=m^>%_SL83~OS;;^)dw#^TvTJa=Ld@CrtIH#|6-1BQQkrj$?L&bil!$8Xq7bTk+ z4G?|oN-l!=B89vd|LXGov-MiZNA>kVE1a1V z0!sX448<0vCtQ;xSZ&4I58gv$G#*+Erwyv%&2wT|!fTFArbh25*Eg*2Ew z>fCH>&*nEco3Ff@T(+}KVvV}lE{NG;2~P;{D{b5LIv4TPXlsLIzY<3|V&6Rk^L}us zJ~ry6GPS})WOsgUj8^KN!BwU}C+mH(lstJ7?6tqHn%hh7 zB|#Bs10suW1k~L z=OjFd5RT`Pxx7Kv7@ImF6o5uBeJJ~W+0-8yE1?^wd;*WBL14bDrwKDt*|l(G7j1cciJbs`05M?(;b?$yV}U8{|`))2xy0SeM9 z<7yVHk&>_ewg%&5XGb59DkQgdEG&zr;bQ_8kWB~j^Ov-RH7wSp#Uw^YHid5VwA>r1X*U_3n7(adP+KWT@2e0>&uM!gaioF_rhB-~R=p)1| zXKPa~d|Us`?+WD~m3{Ag!qk)#>B|_q@(DSh9!pRHlS;jouf8gCA3+rSA01^fQCds5 z?b!)kM!n?>t46w@Lx9lL{fL0*RDZEZ&vFxGwY}(MLz3yyq<)yseOK*PGrMSv+kJKx z!7Yn65n@9cB}7VUw41afd zM0lad%~#j4#ek2?{!7P=50*cc?=6Y;lP9SRdTXoT2KYg8X|S&VO z&YmuO*ECa3iMaDZvD1HCgweUq{m;VVtApP;q9}&h#t$)n>UIZ*~@BMU!R4B6u!N;BO@QH^huwX#V`grNpU}#DO5iNo?cXd0oB#bNt}lc7uuCu*)0r z$6r*#t<>U>=Y88hZ~G9u<+3>x;>hnU4eGM(o2SN9z&u|lS`KS{(5!&a9~_cEY_O43 z^#ntiE01G)bXcmv)42ee)WG6CJHRxF8|&M}KLe?`n)(47f!I{EC!g?hjXj71C8``R zE<{z%TNqdDPD@8l&$7-S5~L%Uq@tq=eC% z7g!V6TN9M>7j~0b$HjCQY2S=!+gxH(;nBG&4}8@7R+V7YS&;#(bD^=k zewTZJJXgTY4b)M7Q}rbLvO1A`q?#keqN(}0#tT~b>5J+=Sh7)A)gPnpaDtng6Zayz z@2ijX*M?WLqTMtx%OVKmyD}O~^%X0e`nwBsPxjc38}K7*9ekQ(7#7&M<{>_9PdGNW z7bkm<3=p*Tf6)O|^^Q#np=tpjclz8|J9D z6qZ9xFeJeO@+ZwUPzvO(10^wk1yme(fT-aDMdU9|pLPG86t#CZ5O5+5lInp+%U)}> z@p_o)af;iI>P&FTLb~U$+BTg#3OZx|6OB_H&5St}-9HQ(tCXnRyaCLU;NB8* zDWr2th2nW>LheGHA=#*=;^Soc_l}pUL<4`Vt42|0#*=O5DS-C9T&z%d}T^C;LBh*BfUpJu`nXyfje7kuo zVWYzjRQWjxljwdt@a{ej`(Xt3FNqyG0bEd%G> zVR-lx+1Koh>K{Wc!6o`kk_iNwsVBz(zQI-&d|5pm0?#nnm`r!FLB4t;pursp=tAL$CWxED|G;vnT58Ru5N0AnOUGoyvO*~2;jTV_q z0ha&+i^Yagi`oyZ$HztEv5?g_g?G5L4_@D286M0Ljen*o3@)9-jdquV{3w<8-z<#C?Wq3Wbip(G2gVdkcmNv(d| z4Y5$Slw|`m$!cH=Rb53yujG5v@_^uT8k|HPnsTw~|FvT^1KU}WST^j!# z3&uY0VMnOJh{RPt*_-(I?)C>uZ%fNOzW+0A)VFZSMe~qf9)DtNX*K!i+KA<-rAfaE z3P`pStYTHe+fC*MEUsR9SbBZ9-W zFDvs@3_0=Af|v6>`oEPFvyG}U>><&OkxEUBlVu9w9ZtSqUZK$F4vQ|`gtT;zXY05P z$uFUo^GkrR?txVgOG7`JS005ekC@Wc8{ELDuddSIrC=p`t!j@DuL?2pQ&wR8^3#DI znRZUNdZ`Ngh9m5`l*1deET8D+H98M@-YwbuT>TpKe*TKhKC)FT;^2qZeL$~mAsg1) z^-@F?@h-;PTUs<84N1{M4Ru``Zjb0sq<76ELV9`GGptFn;KR$j$yq78r%dl0mm1rc zJ3XJix8aTqZ~YQZZH^lq?Dfe{T)|7;dDS$*nLGqwHNd{`)lbCpR z_cX!CHqisqqt-XrsHvyhl3nOWAjQ@8n}9Ths+0N6WwW0CF*KZbQREx?Qb`f;F+}BL zzHxc8*3N4Nr^pa=_dfOY_vzh8Qnv44JjK0b)Zs1OUeS$LCPvmq(ujg!U{!R7yVz;ayeiL1gf6_OCM0CFeXPpNDS2b*yy(Su%g@{}>(9sn4 zG*i%aL`m~3p@bySe@dV964H6p&Q>{g7AtgSMBJJ99<{=>>pYI*fi-<^-cYFOz=+^F zDpG&f(K(Spj7258BgX{ojHunS8D5Fy2eGtw6oS?Wtu{YMwO`+8rS*TX$-VPMDWPx9 zCyGf+J5|L`gIr;gn?<8C%gVc9w zPSi;LdF~&jz#31?GPi1b(%(k9i7zgm-~q&=o;1y1Rm4MKr15t)=yw73*_e7j%TUZ3 zEc>oJyM%r>q!sw0_t_}B=W4~sW{(>eTr#xUSog^VVUl*GrNFr?^ahUo`D+oPbUt`wTgQ+pra+hm!CBhA|@&!B8)5mNVXycg&Kg-bp?C zjufiGpclTW<)rJ&jcn{316GBsO=jL11;)J{ez$!-%t_xJ8I7EMaC08nO|b zIiET?DeW<&2o^tP;;5nw%pe^khi<-)KeJ?*sln9wPd(GM1Y`*wCBRUTQ!)D+4=l>! zYdkh%zGn2!Stw)2J0;cAcfkAe6K$*Fa^*hmKSUfXM3^{EPXDc4!QWbM>y#6L&&JMG z%zpCeAC$o-Y*Cf0uLsc5>9{^+Rx)GLst}rBtmP(E4I!o^+z9hw#jg2QZ+qDuDe68q z`9hoU^12-z^vDRa=(H6o*3&)y%_A5i!2U~1{d1aq*XFJMK*3RUh(hbaAK?Z42*V6# z{_XK!!wCpP$C;g0APhOA9uUnGcFc)kKZTa>`PzAel`q788O>~rjBM!2h~u@;xGISO zD)Jy?9RqjW8P_c;IaGpB$dl5v@Sd!J#9hgTQ@lBFz=E2Qwc_}cq$hi2_Mjs_uT@kG z*lNXOWhiJZ{}Q3|BZl^hERWgM=NgR9wcuzk_9Z&WO74V+FqPXo3_QL7==}k0J_((b z!Fv3_wwTAtohq=D*s&Za{d)pNe#H<3)jZJ##j($9jv2W3w1evI%phUcUpDkq$FW}3 zIIPulw2spJ8yToa-ACxg2{Q%syMHF*nCrrq-gr z%y;9rKN;`jN3FgAS#a4InsC__wC`K?80}yMmMhl+~Cn9bC0>y(LDZa`@zlEd0Nik419Tm^Zy^V2_GZBN&e-^_XkJ}rz8Z>Y3SR=jG zPsirzcvhMgS*)V$hiG}=vo^uEoBgZiY& z;9npS_xdpfYQI<;!U1mrfw z>f75OTn3hF#Z^DyyB4_2W% z3KqCDvLQNn@hbGcs)U?6xkGo*tBK#ry2WMCM+QoZN_@Bg&HTaHgNkAt>0IY856&Ty z?aXPdN}W?Tx&amS?3$4Oo{!3wkht~Kg8;DpxItA<`&@R%HHlE}811V46a;7+CNR<1 zT-ZpohI{NP7~%CCtKS}W*{)CrG4>KZW!Ynx>PWmEBH~^Yq4MNrVEpdc6wts~<==3#6ympyPv0%&h(kq)$pIOt^PNtlsX4}*O(>h?n`uvB6_?6v(M94DMrED3wM>p=%o(U4P0?S`DzE#!3 zqEhB7R}xpVDL)}o{-75L@wQL2@5t~Z%x&_deWz6Xs4@fWCXB=^O|pW-{P|~mfeYVS zMuu7bbF>e~@);s*GT5~g8G%b5juHywf_*1MSjSR%BSH@^hp!|faY)wb|1NYsW}_gQ zNt||`@!LG^l*uES2EGO;B`!?i42(}}2FmoIY}#@A+U(A%+*WM6e3|yUV=ajqh3+m+ zVj6A!7|+g39pwpSBeMfrozK@?Arq1;Ds_g$kFQs=wkxp@6cR*8qVOI>(+ygZVaXVvk0LD*twFG<&FLuKpAD z7q0NL_`~@cRcSseJ;O}DO2u-P!^JrVoL7VF#2q)I_EQ#je*%J>{p!L1dI)gYkgmk@ zgCi7vn}OQ<^H&Fn_xLs5#p@ddvd+8u0D#-oB84^Os5Dv)Jqq$+i~S+z47EAW8QN0% zKb!N=e*~oGBoS+;<+bl27Y!|oM0C~x0A8W3t{!o8-BG8#EsuadFLHbfmWB_$Nwps# z0xLr0=HlsVk4)SKNbO5!thi1_{Hu^bVd{J-Snr ziG=t~n%O1og<}Dz?zMq00WTY?_fRW^qn4~&6IQ0!<*S@Fs`~_d-S@ce4YO6v7{HGuvR5K}4KJASYR;i5+HCVY@uOIXtyxAZ-+NMlGZ*Rm#L1hl1GS z;?8n5mGH5RM=H&MZCHWan_ce3de127+~dw=Z**HB!V`sYywwz%%S@1nze@ zmqHtQUHm}=!%H+-{Glc;)S;dPQOTdI*$;@X1gq^cyUh?Yi3H`(*y^nCRO0|m4TFwE?id$dKGSV_T=j<1F)v^kIVKjPOIzw z*5_qej23e>6$kWKZLh*knp;KOZPdga!p@8z5?^dzzbFvds?jeZxA{#_nFymoxR>uY zb>7-K{b1B!N6z+KU(-Et@AJv>Q6^zEC?yXmw%-Cvpp^dPJ#a~90-;NkwR<#++RSYJ z$jxIUaV=1q?s5d>szgDFzkMrrkV{dq?^uAM9ip(}Tbi@*5A+&(ZNL;d1F1fGS(2m) zQ6x=1FO6?I_^U7jdwD2NduL8Oqq3ZHS%>*>ymApPUGsj=fCLj`>o)^b4Bjj@7mTVz%ILTzc2QYkI`_|Siw_;KeF$WQL~^0 zM|}+HuFaNbox_Fnb!Ly93;7zz{-+@TQbo$dP2FAD;g@_k2LjFBxkbQZ@6_~KetAlI zU{s3#6wWWvriDSAF4MROp8RgR6+Z{Xto9j;@@n%I;Mp4)52RVkaU27EUvxmo&@SjO zQB_b=re8eaJ)p7JOQqh+d&Ij1c>9SL@I`pd_<$>&_gIhtJYj(+a}r*oRtc2^zm+a{ zbG73^ytOu2r*bh~s8TA~Roq{$h@~(=ySR;ZF6ili-z0qT#g0L>5%GsvcpKyXESl z)quUx zFHkk$&42a+T8x3x@p?_LFhr?PaHA6&;Zp-lK;jHVQ&s;?uH5dC; z-9~}Z(3t!xeP?d)Hqm;pHEEp4mzl{FpeHfX-< z0B<{RAHWb~j}=8Z?)Xu`H>5c+%OaYzYJq!Pgy zL4s-*LWWUap8n?=LEhnLrE@ym@WTG9D3Fu;)TX%YkRMguf*Ng=$Nj^Gzeft5hb>}c zd3T}yt)tdOan4t`kwH1*b*zXxf2l{x2da+Kv4mmZZ z#$PW_xV*Mg{>^&bcXJs{WbA=$ZWo!2TC~G+#O|?-J8Fb@VY98jra^stV3uGhM^YP> z#zlLbBX0w!xxTng{z_0E3an`UD!dGd7I-wg%m%W9(mRS{QyFu(ZV^9JWd0fZ6hn;; z6)$dwW3-Akf^r;>d;T^;Gk93&E7jTB32il@0^OT*g|Kw#*CNWlNsgWLY$RAR#jv*s zM^i1TaKruf%K$O6bJ|rUE_^OzlCY$38cE6Kxj^YVDwd_Y&&$e)$>Z}`PM2Acb{tqn zSv<@Iy?NPJv3-w-ah_dx&A{<&O89L5a1{`Dj5+fwkc~Mh;DGarxC^DA7HQvAiZ@$c zG;@)xi?wMo#)&)KFhm)dUC(+XNcLddZfMIri`zXl?`*F^ppeWbmHW>yapT^Kj!s33 zJvr+j;>%aeV$+CbFz?#j8Pm--En+}igWX{)c2pjp$RZzANd=k(gq=3>6>y|aEcLAO z0?lN7V~FFTmM2j&ri2xrO!wQ*fMLF0bOWqzBojvsFy298{oL}*Sq-#I$UPP?b02C* z!lIW8tHuB+B77BSa>bHAuj345O+cqIj$)v!z{ACgrgDRJ4an&0YsY#@OX9jGg^pBn-kd}0%a6_zOfcNLD`Y#DnAwNu^rl~&Q^ znO2dTLKE#J>}pANoJ_05nf~qV9F2^J#0;|fH^(S$d4-lKp^?7xJtRv?7c+@Xm$p6g zpy>Pyg^1bN=N2Z_5A7hQM*H(*Q;%B3WB6396jz41h(d+{D=W3_u1B<1vt`MJ#|}nD z14k}k>r1$+Jby@ndBN#iqq{HTVyyY?W+sG?d>`81NLcCXoEXS4Yj z?0z{7kG<=b#ZOAu89vZtTp#fe+^#szEth@n%zk@XepLIzW`?}op(IRoA-+H&oUBw- zP*s<(E9g@*)7Lh^FU>cDe?xQzgShXEb&K&`?M_2Qo#Mt`u%SnjH$Pe&3$5ibE`EAY z`4t|WE9O`fy-Y-f@YWYF_+24-UQLo!WNURy3ir?&H zxbV7oc_qoxk-}3}L5GL+8OVthxYO0r`NsiiAA{CsFK`%k?yF)5iF6zWJlrBTV%^OG zxyax#dX;`P`v;Ny_GQ0_-1zSTGcibyLMs!-#te5#Ie>R->vX3WJ52kB8Z7Pt`_=^q zvq`Iy*kCm;P3T^*@GYXpSoS7Tx~$&hir>?({76EfPIo^x$6#*P%0CS z4h+z(fSa9K@aOz|b+QlQ1YGzEHH4><1I}5FVs>{3GJX+oYxJ>tkIHC2E%w6X&)=_< ze*O(UwCsQQ->DNAF7A$P zFusg}1G=UoVSo)dtb5tTeK+$*_d#`;Ai&wunZ(vnMZtdu?_R(dFFh1c`3*OCZ!-OQ zMG3B-rj!Ze^@9eZ-Kz|nSB|q*dIP%hnJt*z`b?z3KBrB3?^HzluI&sbfx=Li<#uCtrL~=OYn~<0nB!&9 zH8627z~n~SkLvN(9#E>*JINYO*)Eb=ozWdU0@$f9+2R=so1QTA!=u8(ElTRtqPOTB zkGVI+D4Q{rdqu2&G8kAXyzzE~ExT&wMdPcu+LI^@%XC*-Je-vq#BbpsQT4{pNmv|i z+mB0{H^L!c`{-M)8P(Mw`usHxHa&oa1j+5qO@1|);<|me?y+5ZJEE6J=&U9~7}Rqt zsWL6b{4%bB%@Y9V+~H84s>+$~z~8L7aD=dA`pSM*t?kJsdLk%@$pcDW*;Ny@&|PL# z_FK`$rn(VE%4St@iu0Z$vZsE#0;51zPC^b3C^fq(KU3IP<~z9tXPHNx`}rK@kfqv{ z1AI}7n@9ch6+-)%={brd*qaQO+*vL73o67F!95+HQfgS$=m88vF8GZW zIE2Q;Zy(P0RhsQwtaUvry_ECG1CAX?y;?hFzv8dwjkM(FvDV7^oZhHzl7p8;%22m< z+O%J1x#cc8+zJtB%xeO-)1L2$mWA}}gi+(h_Du+DCO!8vC&o&F8n1F;eI^#Fj47sJ zn6EUWd!c`ZyDVZ%40c}6J2WfSgFc88c!ZgcYSUtX?9!m=Vm)rG*?)N&VQJ9Xv>d;= zdskT0(IY^wuqY#CQDu2?La9Tj@e#BS;24r-0D4m_`5RaoA)obNbg!S@_l?Y)_1$jp zr2UGCIhF*$mpSkza>pptb>7~2nm=CK_bNnxEMQgoc_s|$QMf2Mm}wj=>)C5{44#q7 zW_dpbeXvLc4_>yI+dUp7j@p}7eBah>V+d>YFu}<%;~LcXRfU-1C4Bl8iIf`t)At? zyO%d6jAI#1;dPvV!;=>^dwmZbtPWxy|1vFzYVP?~aDxBn6L{YD)aQ_Rf3W`|k2W{L4__S)Z)Nn{GuskFlI8 zL_T$vRFXcpO(CQY^o~vc#c#ImgD|3{Fv{Q*ItCKmM%(2$RFn(d6|{XSV#TW|ZFCbK zt6BC*ptQS;hnOH1Rl8A~Qv}TuwEub5f}fy+=8RC@l^;(Bm{-ebAJ7aHQ3sa;;axLJ zbNikRRHXc@ljG!c=Nr>?TEEFm+6I>*VIj$d6!GZrHTIEf>3+?T?$8e+*U9B%Ym< zwr703w+l8f6GJ;!V&aA5ACx&D&H>vj0Qdo=^}Juo;V^_dterb-!<@DoMmI-ZDeO6@ z02tjfAYEdsg!}|o;kZvMXL$V*5Ve3-le?F|8DuF+9|^8*#Q7=x3dZriQ-(q%UwU^Q zFiJ9cn&ix9?}H28=p=xdfl~C9~O+Q(09g-3CL)H7MUlGE)BfR5!<2&{u^2j1dpPwZ-R0!%&t)DnIR7>vO@dOrK zMF>WRxtaVt0;2vqMYpg+VS8q~d1^#~oi`4Ze!IxUE|wwYJzbK+YVnV&ytizS5JPi@ zZ$2+IC)Tfl)NUuExYqRWvGnUjb0<@4rwZ5=!0j!?odF=I#!bKfThECA+hR=}5^ za3Nz5|8?Hp%L4onc10+zB;r?gB&&!t=-%AB8VYv%Pq%P~3ul`LX%JO07wuEe4=>FM9?Ql^lDWgS)&T02mP@Id2*g$hl9+Pfk z`6=f>J_~T`ieJ5SmgDnF`fy@T{_AF6e9PGNo}%ZDAWFA`T9T= zKWSJzyGS*y^4ub65Y=RoA#M}#-Cp288lQto7-S_^smq^u;tFXX{8H=# z4o~NUIXbJ}E5r&E_16=_733?uI8Qze#QHdQJ_+r`0+E0_DiTH$o@!60cho^LfbKC*w>TuZYITA-~u_(iZsDuMQS) zvyUW6?R9JpILR~CP7UCTGr2PIBOLKPbXm+{a1Hy!QjSR8NO!8uwKGc+_tHx-dC`30 z^9~I#o-T<}t(R$U0kIo^pX@T%16noAX%RT!YL=$l_|eWRO_uz_Uxcu7l{T9i-tTli zu%dHHrqIxK+-~0lBZ+Y7U6_cbuwkJbmJf2)BGe_fv`np_ak#ZTgU5vvl?OF&bm@&x z&3$bH_9{@{oxr>*dXC7;)b=D7u5U1?+~wE1`dfuLQa$6zFN%Zdeap|PYkwz}XHc|z z=QEX-%428y>Qwk)K?gS)Nj9ODx84)_=5Em6Ul5%J=obt+=qG3- zs8{v=?;=oDdW$e76Q^iLe5nxCt>a)?Cy4V6iQ2a~c-m`fpQLp>8AY<^8TF>Wj)@w* zG@e~8cKx+L)4z8aG$s?AR!!iaF@OCGi$ryt#8BZhX(0Wx-Uq?X;@)m~H`)bHMmdt2 zy&9hkw6n+~UBWnShY>3Y@19&-63Kl93b=0$ET(zzUh1vlU;@soCO_TurWeEm;|x`^ z%#0n`vht)3l7D09G{Y%v)HuWBBcq$;+{=vz%5Ke^Rs642wB3(4*m(>I*+9eUVX#c% z^_5x+ECNHk)$HhQtKa%cYMeM1ORwEZ9x5AKu_7c&b+HXDU}1eUhrb5lcI7{}+3Tbu zVX8h(cLsGEQ|$_(g%9*>N#{J{3IX28LjgDShr30^%VXyCYF7TIx*ICoFB(frz)3x~8wuWJBn8swvc@IQe5{-xTCOQ`tgPq0BZjdH z%utN#BHM8c@x70CZqCpBGlt_WL+(z!p7}m^nVK*p6>`piQ)pM&DwOI9V7?woh|!V* zOSR#rbj)4SJ+~i`Ar-2vGfk_43_3sb9OHj{Jua6L!i8WXY;|uSuqx%*u%Hw@SDONj zoO{<;8?4`^%d8~bG#@sXXDV~NR^Ojc63HxT$Bc|zQ*M(_5M^A8g{NyJ51QB|Y;>!W zYMlb_gMOxNvAE;*a)uLvqugNC zT5sh5LXhPmw-S~@dERlP^7G)QSIYNRuj4;%Wi3XVH@0e2bvO|dat*A_l6UD&SmF%OqJv^d<1R<^&@=J;UC7u&+&B=Ime~kXJZr& zi#n;*o|WI-dNgGus8hRRfOcTvcXfYKR`G9d-WQFmUs>i{cShcdl0wojqV;%XK9}H= z#vFV+MQA856*;`%n|b}1&iBwcgy0e_rO#q2Wo^uqGCKXWeX;+CJxZoV(7-VkMjftJ zrtvf472A&srv#bdKxvUG+v^{3FC$+iX!WDILkv51 zR~`|veZKrB0r^huMqh-|&6#qJJ^uw)n7_u)kjU-eYW7c`Vjo`TG$d7N$)k`5akJiS zH!c=r>;3ptLM*`{`s$hoe>P;KQjeeVo0b25% z-l@1Sn84>})^>-_7>oyr_M&o9-yko}ffBBZ$RoC1JezNs@_)Xc407!#O{W`F>c=aL zMR*Diik}wEKz~~u82aH{wcphiTZjBotJV6%Pp*jIa^R15fe(+Bc<;a4DSdMUCK59E zrXD<=Un#D?2n`rg$>MB(P|_DR@p`z&NaZ#YI9jNiz(SUP&@lLXpi!-xKtWuf>H(9uw28n-f8v3$j;cdT)TE zbJ&Y7k}`#X2&?zsiJl_|5#JQDcFJUElum`^|Kxw3W|}8mc|7UKsN}6z!mlWgb+Jiq zWX0TAOir`Qejxhd$}T-K;QqNuup13=Z^ZgY!61W~b9=J=3u7`c%5v>DU8%Ra&Q8mJ zVd3cJ6~_4QB(JG=v3=}yh>p+l*C;2nZfkt0g&oXTYx=v&4St*Sb28*sbpS%SsP@*u zJ=)rwK~L~~a5QVDRs~Fccr;H9AmefVtXiKN*f*_R-(lwGjE{ z`u~gfvez$<%pIRP%iZ4^v@?a~)h#JC6Wyf&({69?G~SZTRX2mC6A9U4I|(+OBH&9K z-AMzx7OxF4TVta~#)eWhvsyAdRx|Dz>i&B=m!^{a`Q>xfuN%y#rRhzc#R@C#4dbnA zpe$jQ9o2QgmMZ>+*N_ouR*C$FNc0xJ@p-_g-e>FI+CtUNEeTFZqXrb>Do8FCY&oNH?w}b%* z@hYY^OJ8ME`UXm`e}KqYwGrfDl;nbBIC_lfwEIB@!WB*icS)gF#?!%(Fi1B~`tJmn zk6?7?Yexld>SSnVW{_@K`71vY=d4Kh;u?o`+oIK$r%IqUfTE0b!YbVDtuc2Xumd42G#mSxqZu4U@d^UJb zC{LYdSSa`pSom&gXAEk>o%V=;F?aherqAcXl4meLkgC<}IXlBT;=}#jQQG|DRj{Jp zm_AJ;DqEGy{6TCr=1qk=U0HR`IVnqFSC*eCWZZgSc-wJQv2!Z;=X7~0xfw-->sFJY zG79|Q%7+>PC3@+$n2?eTjjY@;hV@m7{Bu7^T*!VJ6UN&AlvC zZ*a_ZZqC=cw?vG1suf%uR%Jdg7#^;ZQa;>9?n;fiWQ*W zN**L42F;EE-3}|csAi$UOREu8LdS*kS9@zH>nVz;I@UEgIlF||ERstRfB4e<9jg>X zNa&QL65iM$aw%Fk2c^MB8^`)`vKJLankaFy7ZMqx`ur)ulm9*ekEmCcK1{t|PX-Nh z0XM!u>p)|A;8vd0i?DL+|Hs~2M#a@_i-LhbAP_9L2NK-fC1`MW3lKaw6onHKJWvqa z-7UC7Ah^4`ySw)0oO?cU-aYs0*W>-^9;3&oAA8iUT6?cK=bA1pmNwotU?qAXb1d4; zmBGr|w?TP9T~WWA??@Bg_36=;a{9nx(t;hLE~UDdf{;va_5Lc?h)K@q^-YAGP^yGv5bJl>kDI)lG|Wm$5EvutzMe5AzpI6`_o+ZR`b&Zxv_z4 zNdtM`O7%_c=*`h}uokFwzgG2(R&$%SXySHCF`v}0u&y|0QkNo$8vJQUd=G++KSAI} zR;j5)h*Rf`lu$XdU(s?#d#HajIop?=5tG#OXn>rTto68amAv_?lf#KoszK0B>T|xV zduYA~jl5K3*^vH#KLhZ-0zblih8Bt{4E+eh_{l!=(c3$a5V=~2mYZDe^_M*<3;wKp zNA@5Kek@XT8nl-J$(OpniW$_XDhFPJ(C-%~3XiADUr*F=XXP1E7!cZBA=adRYsQSm*y&AWS{fY z&v(}2i;g+CuvQ^K4lc;9wprU?C!TO~Ke7me?c8m=I%*|6wgJip9L}y81%!LBI^VT6 z%^;D~a(iNJl%6fe5=a6{9uGGe^$^M`8+x?>Jy!zedgqGUDCD{Tz%y0Tw(dTg|9c$o zqC!8BM)5fbm?K-KqgcLU$+O1*)V~orxc-ow!%x@-83GYj`GgaY>AJdk2AL`9Ph6b= zCbU9upMHMy9i2Y!A3iJI>l@}jp78&$q9|GhSzs}!n9-LJY=hyJW54`XY3dS3E0EhacDFeOz}#_kDsqdBj;;p#`SI0NUZp>rZmYo{6^Av)+r)D$m>1@Z- zs9IArGt*$&(LdMf{VOwQ!zN6}z_zpMt@y}rCe2(0aa;BU$1N+1bS5Mh*(jX$P`tl_8&C4daYt-Te>k*SKYMSP^YCqrN)G3!T9%rF$ zXUIfH1!B@kkL9VP(#Ep9RM^@9+VSwd@KYk>@Cf{UbyRCxZFwIp#3@ed%nt>486F+l zdB09irNW}OsUN{vwpmE% zH4qwWH`iJn(|0g6x6Y@oD_!+~av-hFmjZgMm&a07C(4vtl7UZqbYlW5?i52TkQw@y zima37tUJ2GVId%!pU!ESEi=3Utd+D|&{y^&qwCJdqE6r1y4#O&{$zO6uV10!94kc;2sJ z=p|%LG+u(75?W0=THf9--(45p9QXVtz`ZlN+*>7x=Yj&baBr#tOV&~5t6ai1i|x?* zae}zh^|=qYzp$Ot!EqCk+H1(WQZm>A81%0gf9bwE8R7|q=BQc? zLvE)xCc>ryhQ}tEoORxw`TRZq5kDmO3i!Fp_!q>d#U_b+h_Y~rpYd%zP+GerVR@QcPV*+5JD&UHL ze~m%4%k|xZK*(>6jG{}I#(h?wG^(Y9@eLEgiInw! zUbfLG26cb0Dzn#36ok!sVPs3n6S>xttcHNFhu3E3=aWn!oAmmCgIG!a-YtU3&{sVK z=&r7s*sh4tMcN&((!t4oS^N#+eq?~7)A$*&E?yR%b1IeANb*7e&Yqi-Itl0TxPCRm z5A`g1t;~LykqP8(dQ#P5$p0|^gqUvFF)%WgF1@GTEh;+RB+bhyMf^F{+@z7Old z;wO%&>UBptG9n9B5p0+@z@FYSbM!qIQr)`FIL@YxKZ4t_(KahQmMu4QrsM^VV-?D++D{qXh7=_Q{2)l4rzCHjvq`w{Xb}SO>y< zqAx^E_W(yIdt82{7!>nkq~{-D9@$@DLnau=eDyY`$-nd|DAb>5Kod4K=s%1^aWBG6 z--jAC_7M7lJeKBkS8*X4)MsB>$rq&$VK7Aj@;%lC{Ee$r{E zt=J4AN!F|sUK$a8!`*B+gdaq;Jp0}c-PlA7IeEu(BcY%!oSAQpMrDrvTd6RG!Y`88 z108-*$o`DSZja@C*I)v7<9GeBg}9!E@jd!GAr6|M zbbzT}80s5!cZ98z?4H|m>>MbIbRuyTocW}vQ8~rkIM|Cum=0Q@j)cff(<-N($bAB7 zv9hs%4t(JK#==vTS>0k4jQcS*S!Mm1<+u|qa;qq$N^+bnHD*nb+mM>mW9iS|KZ8jC zU^#?~%RuY5IE08znEmR>hx_md=IB4bEF$NnGZ%-fNh0iOH@Rk%EU+=Wh3wt28Jh+R z4`zn42HFFk0#H8VAp~jpW^TxjpLMT(-(!?>6ab03-E_#5t9*0VV7&?FZmkdfC#2ul ztbe9#xY5-^K;jeMoxRLNWnS+Lo7*4dtUu#9I15WHs!6+mJCM(h>f4+CxUu#2BUW23 zi!w5#AIR&1haXeFj)H{{)LxwjB#Is7{z6brcfsUt=*7y@P}!AP_+}@-DZOP)s45E5 z0(sHSJAcQxNYv#HEZWyIR3jcq{FPz{Iw{>ASnf>-gQMyxyc1&!V!5;O!@F@IcT9S% ze7N==Bk_&WnX_^|EFr(^NakXgPi)vy^ycz*vI<8XonMhLy9A zK)LjfmH>1}mCF0WO-q`P6WAw9fD#&&SFA)38Rl{K|M)mS6Odo61k6w|Mxqohc!qJ_ za%MxceB@{1nq8Fqcwr#OALO4wO9XmV!4s|6B}*wH#)**kq&5Oc2E+486PuIHS}{Gf znf8MK`NayLRPc=pG#Z*y?t$N(8PL01Y=t}+U$NP{83T1ujzTUet7)A+BDJ9A zz3;0nvwq?c5go4~qS)+kFM5xWflyKZ+#t4;&wie%a7)o=d7Nu3s$dEKBSoc2U#fP_ z2{(I%@zE}-<89pZ?<`BWQsE21>8lrql{z(z=`GTAJ1IFA!SoNE40Lng1YhP^$ZHnn z=v^n2$-b=*({aj_v+JmqL@ZKM?GgE^6iaS3UP2SnjA}f)H<%V59=`Dhsvd$V9Ey!{ zY>61HzY?v+(<2flVy+G5eT&vE_M7ls3=4Sk|JG045TDHMm}Erpvt;_C<=m= z2#uI$4>)9Mkee19{ z?dWVL8ibKXx~%u%gM|65o3JENA4+f%5h*7+phgb-NG5HO#S?rjc^Fd&Qj=6GXHUFt zK$)vEIM_5Ln3VvA3qqHZO|dB7Prs79AH;g;6_4fYh~ra~C|K3MYd_4AH`(N1uZbP! zYq!xW#+DzQK1jB}iDbAJUx;eyA^)XYCzgoKi^_>D(fte)C_XJg*7UoL*JL+mHXmHT>UzTUGu_i1_app)oM(&tjR45G12|E5cn2 z`q4UM)u90pR0@(I2vm-7PWmW|Qd%70MYwGgi)pxhvg6p1gW{4Jtl&f3YtgJ@IZx+R zF%=g<%M1OCNQM~n`liHnDR^ZjBS$`XC7KG7nR2W@HeY`70Vk4LH&jRxBduq~nA=hE zlm61R)KsqErQLCzhcc37)tb$C*jCU8iw1*w$ZrGb2io_g5Q9RLUrY68p;OvU{ElYb zwmZb>u~*u+_E?dQ09W^jJqd$&n)5*A0N@b+2RL3Be*&0g8p*R}LsqZ)Ts)xDyryLW z&A%w|8T=$VAj6X2&i~@7|M4P;7K*H;M`gzmL5HQ86I?B)+O1H5G^cw3cxc0=Kh4Lj z+Pf4AN4Lxwcb58HSd9ea@@)>?!TYiIBNUkwNsH%D^2I-ph<;8sXI=R@zMGOmfkhK1 z%rAazl4T*fkfLPLuheJ0M(I@a*CxKeC zYWOEe{BnJ?l^QG{EO1Y}@#%#Bm$M2=?oA2|ME^=lF)F<5J5>qbk~`XVxJc#_i=8qH zrJ1xm4AXO|buuU$3SsH$c6_&>l)tNurIghr(p-H1vAnKaA6jRjY;+PrZ_he%;y|Z? zWv*FFnwUKF+vvoNt|>#QjK9*tp6;g1flUUt)@AR-Sg}e#sd1NxQ~zFinLXT0g%S^e z$Bn}Iak=T$3xpc>pj)D8#8(;xVE&&3Y_5&uSJ`gT9qmr4I%`onEMMb2Oe6MUSOOIj zv<-Ld*FR3bz}R(4a{GN>K{MfG$GW@rCTkSnd^?N1M@-Hi#cEYcc~lDD2kNh3?WbesFXS4&?)QiqqA zES1Nt@>{H}rz`#T{r0m6Hn2s44z_2SIN=XsN#s(Y);DhC<;rkMb>+`NUNUxgd+6EW1FF2xE9=OfQBJ7E-k$IbO9?50n| zb!S;my)E?XX5YX<37?ZQwvfbrtJvk{duq0Ibv-ur)4^eOCn~jKifov{K6GgRxH6Vm znw>{w-F!0sM`n+3BR^H}b?2d!!*;RU*3h1X1HksjwyuK}I%09{Rev0;&0)A%yd}Fh z%jWHS(RoypOpjBs^9}?i;y^Ae(L!uMs^eKl`z);XJ#9vueN*L>(-AbirWQ{`eiFH6 zshcNmrU*A#(Tx1a+5VsDI8QMD*EvQ78^G+(2D643fw)=yBveEE#Ng=4-1@L;?Y6uz z#$#c9c2`ZYxXpEpR4eqMGPp3oD0PaI$UHE`=SBEqA#`#*n@P@#aahEC?h#|_Ty zoXmA}{IyOUlN>xmc$lPRCJSiSP7ewi7zqN=sAE2xV@%!gKGCyRan|(Qag|9pRT!`v z19TlqAwlcSQvuBOZR4P}87JZtVR6~+(qmE>M+K4u<*i}gm&p48yURGY+bDSw-zz)h zk}_px?lBEIa!`ji7<5x%d)RT1BiEs<3A8P7e`qHAu~0~YmU}ht9Jw;ML8;KrlphE@ zr{W5aV|p$3(<)XscBBY3IarB_9vRacR65{rrHiieA-w^gCRMb@djEBdykdc%sWIu~ z-*R(Q@DCV==9OHsw_Ec8eX=MA-A9L?H$^q;hSueCf?g*g0}*(@j^CV*q+BB7;KNk^ zLVp#VVmvUBG5V!4w0CzN{MpUKFRWDAS`JqTZzgi*WW{EDS19*Kkn#_oXPsvrnmW1x-=m5C}@cWHr{+b%wHzVSR<2_H2CP%ginX|Luvq&m2iA zGeDQ{aJlIM(4N&?<6A=H=g*;AZ_TI2M1A$r&`0JgXv$v8OtbkLi#yei#&3JeG$fo% zoYQ9fL{i!fJagtm7mXXZNUiA3df znQ&S8{6w>Yk6N|tbLanXdjC4c&%RK|2x9X}cC=E>1&|(aOA9-pIpo|Hd;JzG8)V85 zAu*AerRG3Hy(`5|bvXIZ*Z%JqLn zHnh2mt$F_FxEPB-aKIC%x`htDoBVVM?vV4v(+TotoW>O4v{a+2b&e4Yt9_oqPhZ?N zH7KQA=Ayv^jITyT_ZCmYdpx8?kJfHrNc0$B?HVD5j67MpP{9C!;=TIxwBP^vqymSS z_XqHEq8i!&7AklmbU&UDgeNp72?D5>Q-|&SdqMoy`oA!NW1};4RLTt)h@YEnYo7=v z1z;))U%${k@scOk@n2`_uM02nM@I8Dn#`6Qw%KsmrbFRrH^0yyxBfEUi|g-J_-iSE zrIP~ars39Ag=++f_+Zvr`>>| zfvxlDV=}`1-3m|S1@(V=;Qj(FkpzGwh;~$KECviD;5VW8AG?uz%;KOZfL{Nf5AI*< zJYFmY0>n_X3DzJ4I!IM6a_T&7W)OgSPO~7^6Y%~<0to(k`>6GX_59!r_g-YOtzOA_ zdd}iYfY+RUQ~5>kcPsowRL@|v9|aO7Aw&Mx#UY?=dN$${h2jBFXT#}y;#Pm){lAk3 z_}wFt>@;4RD5CO`BRdgbKJAA03$XR1p9nF}pOE_BS9toyi{_EPq^%e^0yHt@z2fjh zp@MG#sK0pr58L?6q5e58!rk}VC(3rQ1<`+m;Y%g zR2xx%7}Ol<3y{6V8MJH?=$|%Y3P64IjM*h1M{#f(xnANWla`5WO`#&50J^4IF3~-#nw8lG; zfKS)QI%)v>>z}v*^8h$*xI_4L_19NVNc-21p1u+61qc<#-gpyD4%qN_icp*vPc-r4 z&6jMM!x)(8XMf}s{GAnt>hJrEfG8bmRb~u;(1`hp_7he7N&*P%ocAZ(6ZQTb_!gZX z5m3)2QH~2Bz;x60;}cvyH~sB0~GlmzyG^sQIP;t{r|xF-$Ua6 z53K*MQr5P?snoxE0X*UQ|7Ay#{$;OTWtf}0;;?-MP0eRN$wzJjjsuv(C2O(Os{thM z4jgFVKb#EUKtLh5#GoUWg?(a}|3RQH=DuSz?3Z-8y=1De)IG@M6-dB%WYz!2hW0Zk z6jDY|H!oK_{a(DwU;!iMKVG>MV4H5G^*~c3fCHZ%f3$nzK%ptXJ!$!R9D=`n<7Y6- zB8#_eH02+sUT}$pzZjzuuavgMLrHw(WFAFb zpQBW$2C#=W>P(bR8qK?xkM{zMTHZb3;19L&FJk2N{{@U2jG(t%M2{W1HNxL&Y3n&w zpDHuT!p2h$IG^+eE!8)w_sdkXw$v7Srq#U0_Y{EF~M zUq2s>2~11|IzShd!Y0Z_dfJ>fAm6KB{q@xUeDTX2n!`u^V8CbR(XkitR*U?Cr@hn& zNZor-{~1-JTc_U(+>nf5kOLVCRN`VO-q+Y5u~};eF&jzmFun>R%pTB?*nOBxbrkk< zk)r}1E{y zD2u=b+$bTjxtui9th437qz?5nSE0d=CoveM07~;|Cli=VV2%2Igp~$(KI{uft_cA( z4#T1btPJ_>)VH891Ts3Ew-cXdMa4rBN%Zvenv10C{b>u=(V|O%Y6pd;2c)#732O&# z=^fR+T(tqBsDT)?x1K3mEXF*0`D&+oBjLJML(&XFL@H>O?)5WKfuu+j)>|VZ{CQm4wTrxk2+KXT@LC#YyA@KPY zkpbXGDNosh$cf)XctGI2JSAf)(7S31`~nc zL`I$c#*sa?tx@pBJRcs1E%}}RScH?;IOYA_f?A*1Ob8#V?KZ9X{3%zS)(x&^nH759 zYbyw$uG#xYny9cnEIJ)g#OQ)7lYF(bafYUkr@;fSU?4{l=!Q>0Ucuoqh0w(DtjJ-y;mqT|sTADL^lMF27y+DmA3 z2#RyV!i*v}#1qgwQAyvdO$F%u-?`}zj4x|6s#1P5CgJpSB9H~-habZk5_<&_X%P=c z8`{^`@nP*H8v}_FQ>CJ@!#J1$5jFN3$b^__xUyV!pR#FV(fJ9iNE4}%5uxSipyq5# z`lQZ8RtLOb_|&joZc`O`i?6k)>wPQfr*8G58Mn%usd}4ZdE#=dZxE?wU-4R=I@Kt5 z8Fou?l1-BQJB+TWJe_KXM2_rVT@6fzZsCs-5MO=Q)C0NSrZ@?#9R4$Fbc6YvYovB> z$6>iuqC1`grSIOoREH1*Y;XC|xyf;9Ia!_v%mAV1Q>uWju*7We+2wfa@k75r56u#A zD^l~Jrj`g?o#G#PRSP%FJAXxZu@SC9qgI?Put7&g7Q*Xr$>}a&49#Y#4N1yZ3-9;U zO=0l66Wkik3KQyzXklU|0fK@r-(wm+S@wd%kFJ?B?k(?*U&>Te)=@bq`@{%-=Yup( zo98<5@pX9m8K^R20jZ{vXKmwk@TWLsv6Hr;#f37zHTvjXBw@XMDmOpl zHW(tJ02Se#-7!jD=$&$>3zHhRw9qR7xms%k`D(?aZPWprgnq&Y3!b66JEJmDo~KJU zqqmvgm>O(384(^KAMEw|?8po0n<=AS(ziRNdJkTHV{KRnaPrfEnC{5QS-uhwA2Pd& zqZ9H1v-PheHGzGwXv?_pHT&#GDjUi#7Hthu*OKl!HkUJLZ28HFDH;_&tv)v&E+^Be z10@DxGe`>DaSji6U5?q)Pf0wkHB zIsw{5ZS!IAm6X|4-q~n@guA)?g+??VC+}Iu^Tw>zuJDmVhMTbB;$oc}XT<1{Va%Nj z`?oxtcGESk48ifN;c={a!ohf>S(!Z(gY}{`xk`TH%G?<^?&K|IdJUkj*NqQRV8Lmc zmc18{6=WEQEsX#Ell%+)_GpMVfB{_yD6AdL7Nzp@ov>cW?xKMV7fYewJ9?hy3&Z-v zAiVsSKWxJBE_*klCSGoa&5j)WNr9?ty>)rGi^*yI|*g{gNaz3Gf7&0mTzfPk&VAMqhr@X%q^Mum7CTK493GUTP%#{Z6aOY6M#k zIUSQ`qO+90VIe(=p~-aARmfMACc0QVm0+sOxy5039iU}Ggq)x;Oy(`d4ae#5FLMgy1UJIeT1HEc6nh)Md?YjeK#LpnnXx^1Ly@| zC`A4oGa6g<)l}E;*c}6K=c#Q{Y9nz?97?~h*|vN(R;=)M8A%EO*7a|3nMI?2XazP- zFp#{BfgqG26h!3CIXO)q`S`fzJOnM&pN}dzS(GVa6})&G{lbg~Nk2)B+P%H*xh*+( z_x!im^v{PMpINrP;wiIFGKoxXUcqffllgs$_b8N7+A;a6-M_Nk=Q;{rwA*5grE3r{ zl86pGPpTDr47B+E!(#kPLwWY)o!H`qhUf6lrS#Q;!~om_pbdVXuK8P?pS(k&L*ZdS zy-rvD*P1Var!c+rzN)G5>BMBlbm{=_5+_cM7!D|r__`hOHh#rKXFntlCITq^Z29eZ zL7Z6~k}qVG4@@(AREfVc!!NE}Utc0L8|qMjzC#T24BI*?O^P9=D_L|AB*HG5oSs;1 zNd4nArT7&Jn^4AxP+bXm zT@#TL8c94TBNOaQkW);gjI;AZ%L4Tz^P(#E)(-1f^{>!sP7KD}hR3Xc{Jrv>Nz7@d zYi=@Z!eb+(jB6u%1zfacj@s7LFAwvcVeAM;lelOvF7LmJM^M-Uj@H;E;vMK@o~zr|`clTe&t2a>g3j5izeIYL&)n7rDVcgqRU`>!%bqOBAz6F)f53e^n1zK~h*O;64* zaUyP_hP8%kWdiGznH*+Aa}5tmjU6lcj(Uhq_<1i~oSct*^@EsB_1ilfxqK@ygj0x& zK`Ud<_LS32uXxZ+8PTuW8V-iw9z27m$fMSthmG)K6@O`9lHy3)w*M|?^Szzrq2dPzr$e$ z*SFvzrV80t^~oycqZb8Ym)viCA2riIK3_6Ee4MOG-@I6Oh)_!AG2ve8)F;fVc*stc zGNG`lw!O2f@*zaVUO1Be_tE|FXK!QY-2yvdlzX&X3WGUiN6+uEeV&~u=!I4(n5)Ee{q_nmqFVqn zl13?Rd#so)kqetnQ_K%SkSQI@tazg~qaM;`|1m4R>T~$#eQ~kC9V&`QYL$fTiF`xc zz;U}b7%sd}9y+dpS_!Xt*ZX5-VvKb%zG3m^tr+zg+z><=o5DhVJ;V26ew3$DGv&=woPj{1PejWpFgLB`0s0;OqqNG zQ6|=n*qJ(s&Dv`yJ8$$8YDBYHU{RB6V;;<5FTDLcZ(LrioeS;Gb1Ov^!G`eA^ZkAa z8>lj`RUp8KNIqWc5e9nh1KtG7WKTPzhljIF?6^sR`2Iv5x#Ie3Ut2dUao=wdDILo! zhjdz1_8hUt>wUuE6nD}<5k?-o7OFoBU`WjgUd|kN4wV>Yw<1wc0ID@SRn7#Db!XUk!Hh`RI&B)>7`0-2lnkNR#`%FKt2#Gl2*Gu(a0B%s=+1}n z#~d-7+bxk%Pn?Dd*(4U=dlL@&^5pmVwek=3NrVZF_ZYr{UsHPbwmrnU$B%b|ar3}4 zIc31)c16AjLEUsb*MsEv#1;d&G^J>RL2LCguc6VXd9_N1dM1EKV{-Cnrpc)6pjMR} z)P7^xXWI}TR;)qI<9_D?i*P7q7O{nkrPauPY|Rb2&(i(8%B6gmagm(aA|z-kYYorQ zShzgdcASwtFddnxs#nO)5q6_3kS0Y&Wx&euG1WBLR?94U@ndAn)vlbm5;qAnE70ES z>)?I36CO01Jzvl$zgtZN27la6+DsGnRjBWMNi^6pkqkMt048&`(O}@JKd$?DDtWYI z1uW~2-E`@WVryz_l505Uefs|7hZx(5@qYj7;)$#!neXNmVnr~n8%6V}zIT>Qr|w$X z`PO{a4Bx-^;NhYNkf-x7-51N4nXA0@7pi?AbA9ZA=kj1aPNX5QIc9fiFjg-M8I-DT zjL=%GhdQJ5WVe7~4)R?9s_H}1Tl>02hcN}R;lyD7-ClSG52pMAq-l?|1+jPBPFGlP zV>(h&(DDcO;j3|3n()hD;WSR2>1gnt#t)eFCtM9H^vs5|c|Pn+s09+#fm{c)=`J)J zF0U4$KpnjtOuFoO$v?8eU$ow_pz zU^?N(gr1lLRKBnY#yc+PTj5!ZuEdAUtJBh<)5Cqs?i+0s$tCPf8xM{U%gp>6Ri*aV z%l56%kp$ak-ataE(&qHbQcAVH3BvXn*F{dk$!ag}@WhN2$jOM~!fl2Shu-8Z&m4E1 z9C3f=jY*drZ;}eaOof*f!Hk$jH#;aMnI2=c(H4_ew+2tvlV1BROgCq5?2( ztG5M2SDp~Q`{`%{0&78ay!;+P(j$R>0VTzb;hZsnGIl0w&o%c$>MaJw6@w0cMe?~Q zR))b^9vS$9O;9d3MoCVk-57W2?b*b%#E`><6Mv{|`+EEP_g7}87s6CQs9o_R1yi25 zOGQ`w86pAeAorWojA$)Z7Hsjlfs4ioo+dh<*x4A-v*L0~GyjFFn&$ps&*CcgkgjDJ z58W+q{ky4OBtQL-?h+8-hxjPgf7%Qwa=kb>Ik6e?o@&43u%5^0II!a7i5-jAY26Wl zzv0qpbn|h!xJ!n&cbDJSdP!~sd+#Mk3-AUUDVy0~VL4BxQ@Ep`WbxCpMMws!-OjnE z>2Ud!a_VO)mj+=Pzafo={-yj8_@Py`G)UQ_BWJqO5T(L&Jk)%mK#X_)i?BFldUb#@ zt)AFz99d9VQ3<^o5O9C~>4V9g4`dsC4rdd^V_UOidilD>$fu3+_YPb!@ruFE&c(B@ z6Oc9|eGIaS8*yp@y<@pGN_A#g_*j@nZH{d`2A)VmSuLwWn+uhvweO)kX)c9Ubp^GZ zx@587^A~9cUH?u8G!mY>GoTX&TlfqgMbR)&--~NBdl9=lm65)b2Xx_6*C|qlW*n0T zdhehf*_c)r7}$PnPB8Nqji@@{m+uqJS@_P{sD=a=Eeaaj;WqzD!mez8ArY2vk7jQe zMnQq)+IRUg%7KIR1tu<8mXc+)yVcSw4N4Qut@F-QFBOA{U&ISVd7!nZjZS)xYwan0 zMsYFEX_w2=rSpjtZF;=%nlv4~d0Z|h;$S^v``T4^{s+>Uks*>Lj9daNqdE>6B|;K{ zUw~J4)D>@`f0ILZd+|h*$Q0KvD}+CH7=7)zx9s^4 z#Yra6hG*-(4pL*MT)RZqUh3ivLekMY{i?8(5R6G@_-^;rGG$@p?Zzs%}Boq?BN zG~ROx#i2K0>0W;JskZ_Xs^fIgl7LymTloK-(Ro#&emse4XDE*l3K=FLGb=!is)=_P zdQ+!ZvO+=uN~?9=i6Z&2Si0U9Kb-8@zfxfHwpR`qm0Dt7ylhu?IH=S77SbUkgq0CN zr6Y+mKO0W}gO{9wK3TviONUe5eSdvr+GXlq^CeL^v)c3HGCP zc#Cz)+>=@irIRkps;zdXY=|>5gctAcK1^5MyiqCs^e~mn{q;oX6WDe{x+b1mPJ;UK z*aS$$f7>EEIHZyM8WEQZmhEovy)q@u{SA7paXrTMQPCKfXPiC_gQo*m2RX}9uy4jG zjfQ6f=Y$d1$!8TUr4Z_Km)BTWNii1{L#04N&rX3L8Mk(yp_fD)mNQa5h^rNdgqE+2 z!-hJPfGSRL+2N2mxDPLh`s}Ia&0bw)1>HNcdK`a7sNs%RyF*brW{Lka_4N~fL_vFpa--YmMkJP!2dSu=b-{x+i!&{jh4ozR?|puYB$ztv zdtT!Vht#nhvEchD8>aD|!s8OO=l9GY=sRw!Qi2fC2fdhY$J%K01WsC&`yXc!&s>=V znk*(PKTDf*r3ugxI>ULKXQJ)9e6tAvI&%l^rUzZ$pWhZ#NOkf?0|Am`U_4SmMY+)cyz5c1F9gk6 z-G12bz{x&m!`t(MFfG|5QS$0|J&m8QZrGaTAq{B!fM*#Vq(^&tb4b`tG*AQ?3NQjg zOUN+l3*In%y%J_LZX`dw+thtt?O}7bIT6GK*@5#GK4D8eSh+_lyMcp&T#ucs9;5PV zmW{)zstSoTU?U#PUs^TL8dS9^SWn%r48Xz-%>J}zyIo7%RxYtI7FO@{7QCWcpUJ26cnL>` z4|(Iwh_NvE!Zsh(T#IFLT>W;9aonBaGxk!nun{iLbjceAOE1Xm25S3C6k$|qNKJ}h z2y1JIuZzDaSynh8|M-7TwGzE@E2kfj8Rrpr^cEm`Xyym4M=6Z)zf3o~%LSSH)-m-5U* zmHKW6G`pi!`x{wig19=Mq30*MAW^@d5|(Tkqw=JheHf%zGyBs|6hb;5JA)(CfB4wf z&ZIGUb#8j|VFi??l;xmWlnz4BgGBYNj0=11??_AT*E3+gbO#S=58Rjs8vxDWdhj&* zI<(s-^!=cZFkzt*QfUnbT1vH2h0Rp7M>5-s^QW zH*078H_v^v%udX&K4HQ@0#Pgf%^mm*dS1-S$ALCy1w$!XP=~eij>i9R>~|wBt*Ax) zK#?->X{FEeHFw#s{5#@E$@vr~1PHM@BuzIS-)BuqX04Shi-NTmix$IXO6&Bis^%Gm zi0xzg=iP7c)A))EFQ_9=YdVwYYTbLfWOK~3i{#QGxEv%}2_52`2@eb0CrIgevM7Q~E|@_~N&y>p<1-EZ zIwD+b7T3Iv+oSJ&f3CY@F(c#MMxq_Z_w*Xz>MnTP!HslBT2#lWAD$eEA0X=I?b#P1y(d^=U6TZ#tl6tZ9-HyuvtHymjmHhul!HRg_X%xQ%& zKDmhG?sCmlpZmSFuQ`Q1sBfliro4XZ=j4w4caoCS#;T5_}Mv}E7^9)ov zuQ}EUpWKyn%;KrwDWz~U*{KNa-{tI46+YkJ(f!OZFC~!S`n{LBZb(fL- zBnB59+-&)ZLD=iWhg@1+=^`(QcL&OYGiE>)dWD8;;pmAhybppHl4)n@twA9ueJ~ z&uc4Hq+7!1l=V*N^%lqKDM3u*vYhl(;2fRukm>QR8q;HEZuNf*`oy=)g`p#E8@p?3 zalhI&^dFed{HWlgy+2g|<7h75X`0sRpgq_i!L&V{2zYIQFXo}7C};x+?y}3)Up*S>|;N7DdK<4EX)|ssHwC z+>$4!gQsC_subtbb@@?izso*3!0V9R>_tq?u&g!%e%sQko8FWx1@*-ZQV@HlsP*vr ziKw>J(8a6bE)3MtfIp?Kp``ob-i<;b6Y>k~@zhf}_3dk1&!Q_HRvUKEZ;#)(bNR&$ zsAd;8-u5bnPF|!#l^gdhl+Io1d7{z>wHe(PpiZ+|>!X`jT8$;}gC7VriXLJ)Jedgj z?IQ9JOuF)f7;`;7=odzG}xY@-=dxDEY}PF+COysTp&0mZf2Akv_7^?DQ8er=+@e&1OJ zpiG<@qY}?>;-Xj{DBB#RFOkx}HmMsbtXRM|Dq^nn`k_Oi@iRAjwGnFBuTkkcsm@`H z%(v8gp!DafkDbhFdp}HSyWl^DMOf6&bKa|yh`pW?L8Up*5>t^krwOdg%d5>Xzst|l z)KnpKm>#1xAJt_u7Y`bpe_PRpAo1^Y1H{qR9Xx_dNJ@RFlVc@N+hlC6APv4G_lhgIriPm zHZ39^*EzT3HJCSD9lMOTRIEDc)4|S{e{e9DPZNKcH)Ees>tL+f^8Swbs6%0O z!{RQMUtG=&m~6@{#0arJb%MHxk7P3R%+Sm3`=LWZ(w6C9#oj*|6>1Y4$7=aD-a@%p za>b|Ds#qHcP~r(pX@b-WHDk$TFW--Md{3m@zl$$;U_Zg8i>zpHJl(s#!GG`=g$NVE z5CM7X5VOGs#~mzp*3o0co3HoQKeA1r@^OWI-Dy5w^|1c*v_@#W366YE3<)LabZt5( zRiQMwBktzEF)x?)nM>EA$kUiJ=-R<1;5bs_w)t@T`^26wM|RH~gG}g)=hYdfjLqs@ z{oTAgU_-&2?HO4{?o8A~bARh_P4(q^(hEY_;03{~o*^zvVM?2Mo&LOWWC9_FPR!SF zDw_IHuQ!m)MF3xOXwY{0v&sUMZ;fubSyz1`7EJ+Krh7>z%x5;2(RAgubOO4CT@i=^ z=A`MA=84GEz-m4MvSo#&!g$&4oQ`mJjck(a59Gs&G+Yo-p{Ty<+u17qG32vw#}!CS zK1c2mT-3v}=B+Z|aRo?2h!6__Yb$EPq(+BCP0v!z{-yHXgd`2jkRP2xuWQ_H-Bh;K zo2m=4&%UNBo+p>fAdiTzu=KA`h9SM6jaH!V%ivl8I~M8*6q@9(Z|aS_<=yU>$(Pe| z`mSEEYCt|pO>+1i0djHueK%2J!Gq~OOWLg8@|IusQo(R<0J|#pB$kio%%mfUw)aG3 zs0mKbrIhuq*d2CEw5rYX)6(cN_1!gTSX#Zv$L)>hs6=eaIsZ!nO*Q-%!wxz50kvyW zGyaZ{dtYGmR#NH+(AC_Pc_pC+acjq#_IMDRRL2Azt!+TPI=RDE=bA} zff8 zn@c0zpmaBKX{5V5r5mI>L}`%jlJ4&QKW66Xy!YnKKWnkzu6sZ3IeVYod!N0-)T_2B zZ$bu#?V)gqs3EZkgQ2m}MzraY-9A&s6R*<69nCOH-c_(8hj4vPlPSa1W9iD$x1c5& zQMRkEGNVdGOgA4N#O|aFGWF!;sWBY|u~kvLU4Sbk8)4RXs!`qI=qqX)=xvr8Icv}t zA6GBHprOrGsgpY!_r!tkR6aY%8b`gM4#me#9WET7f(tYsR!1S1JUqc3f|7rkj*Qd%{Fws&#M#BhW*0s*4)oJE$q+tW z_9zdQr-SyVmsEv{Br)3V<-wQ!{C%~OSoHVa6FycIf$MedUk!l}?UHY{RHxqj<#@iuIiu6?&XHHp-yTPHsc_d$3GJx=U zuZvDtD=D;;3o2;|R{sxZpRVUnU#)-TmbwL>5_2c0>80248_l5X^H-P^k$6{|a(<9UR3uAOj7@kE=BC~%Qj!*9 zn{3*A(%59FQ~LtZjpR(ov{|+L3A?)P#{!rb763pji5KrcWCT75Bmp)5yW7wpL)<+{4LixPnC_lD5v+ zRlg7DEX_WqP^08*aJuNUe`9CWAf0t>vwA(FFxW7V&m(;?l)rbFoTE3pg&#aN%1`ib z_69$35&FBpQh%|I{^O_dKxa{*!4KuI1~?pz+PJITp|m`>eeEKWTfq#ikpt+R9f$eexD2p^?;0BD-{+n$uZzt?}T(-8WQ9mD0~*vD`AP7r@?I zrtVlc@tuS%E!IQCS>-6l)1srJ3S7e3R@Z{(({gyNT1p$LVkYL=Hr{dMit9yE*BYZX z?wCX~y{&hTNj^A)LmK!EzEny5*@3CX2(Y<>nU2hsa zqCRN2qElo}D%>mX=&{+g-647RVl34gqR(2h!O&}zN9C-`JZdCTvm1N5BrEOroj_0_Jml?^vy`3z2 zVGzuhGcXEDe4ftg)udaKaGtoA4nr*-vEwWdS$2j>n3$|V&n6)w&bsz>B~(Pjw^*(k zKNb^>9NW#OYZ*k5kh{*B3m=c}zz0s}m_Qt(c3; zfVB5WkAhLYWY@&$x0Ud%___l?pWlcEK>xCVe?*c)EDhfd8wi8-6OT$**E(Q2Cd}x9 z*rkPX52`Gsy2kq<5esz7y=?VwtM#4TSD(@KX1R0rc}N#w#%;xLSd_JF`gUEU7YJ+N zC3=7d?P`buGvZqpDf4zluX1B$G(1{m4RyOK=uaZkvz0Ey=k#qrS6yX;;@` z^&N>WMP`|_aGB7QOgqSUaH(x{C#Og>IE9j8s199gVkZ|_xO75vOxm!3Ptvm^3q49;Wo)ngraI1WL-io$wjvP zsn5xy#^zV1h=_>bFKdcRYOl1*J0E+PZ@IAFJr(oD!6a0nO_t^5U9jZ?xRXF+YK*tBS}grZ6S*5i%Ua2iKQ$+7+7gt-BZXs~bjl1`?GwnR`np z2^TKxT3D98jC7R}8^s^aOlxZjsdd5`u6o}yx6dz5$5#wI6}ISs_=4Y!wB;Pcs*@UIo`{mTI*M1jk!_65JP8d}$iD#og>{`Z2bw=aCezU z1X=6#v4Sba1o42{t?!c-hWNZRQ^Bu(?)r}336APrQk_E$T6ud*cqR4^f{hgTJ>jq*EWui^;Zl%)y7{6R4dDYi*(k*(OgB^Yy5>nuT8=ZiZP=#_y}FA? z(Jb*{lfGI+XKl~oA^CnAR#4J;Iy?#VJ*F}X8=4EHs5W*l$O=^bhI`hjhk+K6WT?Wx zjkK+qn1*TeSp^BCmGNDtG=AQyh8|Q_`&qbF;f-3!NDK2;YS*50{N8mykfa~Cc*m3D zzVjPQLZ?Ws_Iy1jd&5h{WieMngRvb4%3|A36CIiO2zEGhvn^J7v2Qp^t~AIPhGVKh zfmu#Tm|?J&Nk0DYNBg=-kSHg!%^JQ>x<0Meef8|aKppXuijyVn#Xso3vnJVxkCjAUjZI9!qLsprX>F8jMW z1*(jahUm%38A}=HQ}qY1dsA)!5(t3|#o8#Mj)n-{kMz1K3-(hX;is&f@ zL;Ic)x0;p!dd{JW5cxB97rEn08V1(~5^EAeBTC8nVoMOc@q?+P;VIeMu|fr+n0*_Koje6*OiPhBhW%Os z_kl3G5`on6S?XPv4H7A%53AgImG9<)D&oyR{u_unUOh$@*Y#g;d_W8SK>^)o4rXyP zck|t-;TqNMe*SV-#|9?73@Zky9>rR<0{8bP^r{i6!nG>Ac)Wr)^S39mdil2GI}gv^ zv&s_PvA+CP9^=j7b*^~5&OPj)OXl8iU{tVh9c=n{^vk27!iLluZa>_UiWdW14- z$1ejO3ONR_exENllMC8(ebauWlkP?8pc%$&^gwf;g&)2V5V}qDV(29BTf{kS*JFtE zs*OiE*u`Ao<*;Clk0UCJizHWL55DZY_U2nrcV?7IkGg3^0fzns1=Y*A$bJiqnYSU` zejlUs?dy@%1SVAuUFM8YkQFA|D%@7nF)Vb1$@9wj1t3QhQ%fNvy-rSIurX+^Izl zu28w%|5YIK5g#ot<;}oUcUU8zX#Xr|bdo4q#SVrgbBI`W#)&yj`+A?j;zb@b8x0<^ zsM&!KORkI>-=h~jZC&;2mcsA%(b~vBo}-w^U=P^4YMaVAE=h+hkejsA@!X9^tv&RT zOqm{}~AypKd0+eS(KvMMZxHE6^n9kPZY`Gf^q{%M2vx%PbjFuB1 zf)5BR@DcWIUDEnG`BZupSJXG=dqckon=x*A8=-ZAB?in4m(U+p~)i_q6Qw15WQ;g(E!`pW})BLUH# z#Zg}614?7@7!}9mw5!$p6o9f8_uPcE1wU3x!`dGu*Le;zmtF8Bg4u(?l6_-}1n2Uh zNd4}{yxH5GnK-M09p5g$SSXWIyz^FZPRr@{NuTGAAwziOGqvjwu-}m9<{O8~cF9haurO7gRze2@7p*-O(hMuw0YM`bNYXWc*A=;9t(` zRD}&`6e))mtV`TBN_kF28G@%y^rK(no^OG2U0kf%KvheF(za>Z;N6RTm~Uu^@f?+T z@<+NN2J@Ff>0z^!+~@lz^cIUP3NmW-x*1YjmMLYWO1)|=3uxv0e1qBf``(i`6xJ(- z@O0`mA4?bO1gZ#v-OUyI0!T2;y0i6EUx%P*tZRrH>)*saTHOTl(M&a=DP~#TE{4W|g2f z1I$|5Z-c2WWP!e2XdT}A5~gen$H3g)RJWSG1gCa+T&^W|Ov$N53pe&(~e(1_QcS}%{Cw>{Y2K{h|Q5Dmwb%&uYFYh61% z^Wndr?`_qqx8~eaW1^V7C7i=A_g&axdmHwi!*$6EM{%f6Qu}04POGt50u-*^0~1JiTO89v<1fl-j|$sjlXoe6IyOUY%f&B5euXZGQQ@eGh)gFj-l0h<;usR|We; zctCNN+!KxtdJqwFoCQcXf8zqrzz!QV@kj_&JStclyt{}o7euS zYJPe{&UtSnE754+$3B17ShpJ)?c7o_wr=M}P7xDTwwsDsuYtUL!E!If(tx~>qu_cK6r8L|m4o>zQ(e~mh6c+iO z?y#c~Ufq2yNE+xpoOUrjPmeQBuzSXuS@9)}_3Qn`iL!d-PKr6(Z}DPt%S^L(feu$S zObu8k+d$Nd?Nfd2TWwWR2#D9Q;=%%onxEI6aIKFwiJ}~N#JHFqQcHiEKU6}XPFPf) z(Q4e_K1;3>S@>k8D(>8>K(4mIr=c^r$gmUUp0M|EvFO1}=gTnj>3?fu0seHPI^*GY z*IQk3tnwYr_^WbQgl8sFXH{Sh8lCb0Hie zo++wN$cptI{!>-(9KF0c-sl@U=63Ebtcb+{bbGQq?6uO#c+;`ZuFrb8YAK%k1$2i} z#JL(cu!l9g;K*u?CGLqNp1%{UvN@knXkYn=^Mq<`8P%exISB1iRe7$`h)5~?Zoo8u zyVkK)W7<}3z|pXWqo}=hxFG*z3~+hZ&^+Qe&|ZPSv=NJ1y`KVUSKX z>z=$vncd4dqelCeLfO_4d5lPq> z+L*FSz0ewvjMG3t*_nukM;yJ5M>R|=s!mWH_$Vrbw77-xiyiws8whQ^y}}@me%>Hk zr)B@z)yTQgilH>qlfMBD2y(F%7W1LB>rHrcvXlJEgHMqGvL;2!8L$Hi;&a&dUI$y; z7WT&5U7&%MR*nU;qE0RSgIG~dPuqzH*J6h74P+O!i>eszPCvNyrqLyKmR&B()r9R#C6jfKdE;x!9gN+_$0f6GTm#A+6$jekH@1 zE7Gn-En@Sj)UOu855Zf#(xz`Vk)2%DE2PAdJ1L``89#>xSaN6z*RR@wT&+iJE;%_r z@Cs<#Rq=#17|~uUc7|mV<8D;rG>D>WdF*SXo8syBn~`4Y-@G@=G4FEGz7Vl1GGYVI z$f)05nAGn!34|6%ML0B|#Tl3ZVeMUyOkLv8Ev2qHXpZzrxeh6?{t_!aiFgae_>DxU zN*TU*BpJ1B0eu=na3uaxL~xs!UOXXbSVBRNHn=I>D0`wYT?O-t{KM|qj!lxOd#5Hf ze8CyTQSqqHhB*H^zwnC%O%Dabnm4FL|RyofLa?-THZq2ZAFactBFSW>$eu7 zOGo|Fc4HY?A`$N+J88!^t`LUD_P31I(C|~udRLEFhfz2rrglhYG9^+ut@-)3hcZf1 zvSbaew`mxLi^}X(W+TgJQ(Z5I^B!YfO=*0Nz?5t3a$LO+8R1RcQSg1#*S5fQh3n-$ zE90Xm#d2{5?pH5g4h1tb3m8E^p>J9Q!sc0UiL|EfEX!Q#HQZ-RR9T1Jf`}kX#kH;@ zzPHt;v4B%;fEtsNgh#4Q9M725nmbcXn~vA>?ADqS3LDufGq?-+t*|+<6ZUC#SP5P) z4}Cgo5`34B*^Plssc5od#uQ-l+oth0=+Ptd6%N@!5n!XOj_buSSe;}Fyyp>K1xXez zuF_y{{a{!>RvI>R>uwYzo8dZ#ZiqJTvCp#TeLEcdk=o6^B%we#OZBkvgJCNMN(rYu zHsqje%vR$#E-m-<%@qnrS6|f9vVIdtRAG?R^XSfMbGjcFOJhh?zf2Du?DqBTJ+_ik z&^mTlnHydusuVY4%7vIrm&CKLZ7*naq{X*T0XMB^#8q_RPvowh!{ugAQSQwo`hf0v zI)~x%q-$aGW?ms;%ACyYAlfY@bvWKP^5+z@O2x*@e@Hp>mbMqJEbnB!C-^R(d+(TI z^IXS+)%-P!S<X&V%(^ z57Wt-*okkgE9tOirCMy@CPKH9GwVHEOcXI>zzNvOSS8gX=5FZr?qvMaH4PuYnn0(_ zq-t&_LwJubZv9ZuXG_xjyc3bO^bE_yfkPc18|Z@JToDsclaQWS_HrbQten|k0Cl>H z@4ALg7GF9tm{;(nPG!VowkZjwGEq znYrOKS6SDZJ0PDPCVW~=zP2D}#@=ig2PsKj0*NCwW64$W<;{>3*2KPxG9J;;B8(`9 zdmH-mXFLpPhzK5E@HJGiJsfSU#DOyRA-Dxo?VaV&SS8 zmQZDnd2~F~h<0{6$Z9pcihsX;;7}!usJL@qz7i65oRsCkOQbCL!2wH-bKcf4-r;UK zy;wORDWKB#nG+gFakcWH<_qaaAd$L>CMaLuHicuJqP6>++=&X7pmft;3iuhHQ0Ky>I?oJLFjy? zl6Tav?w{|XdOTyNYvxoD^-;O|@Yex4*y2k)7Ps4;jTswuPVK-5l)af^`7&(_cshld z;=bHH!1%a&4bc3L34Fxje#_=5(vPC>p!#*jQ7&wbq7`(40FMPeQZ14yfv<%O0wAvX||3p<(F* zRWve;yRU$pP-F)CsY*r_n)>|ZhVvFOPiCmM(_UTS#Eir;39Wjg}W<@uii;*9ucbIxI=wl%e%2H3CU~yLlhwD9h$8eY} zZwHSZ+4{m*gne`|P`Y6Ok%E&E+tDQm?q5cJ(e>Eh=#L+m$DH+7@v_72O2>ez4j$oa zU8MMcv~QXH^%uK6RVV6FavF&?q=`~J75$mPsy)URY=0rG({Wi zTCZl3SfLuIWg2qt@U4$U1oz#E)e*z*-h2*`rNU(1=!D}!+2IRJyVM4^yS!J$Tay!$ z9GFLq1k`W8<7274Ju81PvvqQ|J+e=O5J>wfw{{Mrplb2n20;YB#+7Vlfjg|9Lr^$g zk+cvOn?aa+AwEh(=>|x! z@(oY!8S%`_y$_9FdYS#i*KaRA7W02P;Cixo&{}J-NlE0!?m1Hd zx%5a(jecFm80iu3sWL7nXDLoRWH&o^y*_Vbyf)E~V?Djdp)sB^A}j7p)JhQHz~@^s zdK^RwBV_D%0mi9PFFi@9r~vuxq;=bX?(cB5fa-D&CA(p1`3 zmuO&C=x~<^T$X7FV+DEb210?1zyM4>i9J}?k%lUA)D7>7=6oi*5mRQKp!SL)(Rpsl zsOkIux{R;JX&zIsLb`XeL#Q25Crhv!aECKDW)(vhb!c)jz9RU!G*CeTPUrLZc)Z?6 zGZG2&HjR57?Y-!PqTW@r^-?=@Ly~o<S7J0g^s^~pd&P@4F5`=Q zM&I#|5zy*wa}2+{NsdkcN81LJTap4dNMZFKW9lJjeeEkG+=fg3!CAkYM1I^yUU||R zaM(@rIi}l|6dUXLqKS$CkeZjd>ofVt0bN~gE!>=@D|6G(A;m}e-XwIxk{iV$MS^y$ zyjX>GYP3)m$V}}hYl+h1vpY3n12q#N#R=oHLfU zG;zUISb55>l-t^hk3h*LR`Q6oZkz*xaFTN>^+d&RSzF` z)Sg-Nh75&f^!tY&t-!v(G1WA@CH=}3@~CD-9) zK^WLEFYSpGw8Bv zB@&`hDXre#xjGI$l^DbpQC~kGfDh;13Xe52?w<-&e<_G{*FH&CsUFTS5mYtm`u%HU zftuhLF)tB_fmWH8CE0s>MI~&4!(dyA3Tb=xN*fV(EXVPtSwvfVBAsTdYr4qJMgpP{pvqrp zDRT0MePOhFqM;qHyJd=H@^OCJg1G$#iig6SXV#73BNjI9b?OGHDS$(RvkbWUfl+Yk%Mj(_NJ#DMv}aY&9}y%4AEDVzObE-PRX;o@!+*)K%Y^GxH#=MBj?P zdaivnm+vDcTO96}IMJYDmEC;>$EHBp8le6{btn}+h-uEM-r)u*6 z1&(F&Uc8*_=Hk({?jqRN_myM_Icw2??oTE1(FXG7)1n9Tgj*gWX$`%hn$PQro zzCbpsS90acA~|o3SvCn7*r}%iqw@j|Q01FmIJsaqb;X+J`LbA&=ZM8o=H0$o_|P_w z)#7M>N*)v#7)h5V_+u5;fWvNi@n%oZt{sVdV(kz(^Oy}G_z2Ytu3zINiWxRJ^7-QaLEbX=vIX zzd?zm$B}w}MyrD&(`4WNNO^@%ei=o8pvQr@2`V;oF= zkQyGAlT*Yh_qH@x@$wdaoQ{mo_G$MCk`E~Em0MA54UMpAa9~gr)cBpM1g(pKZ|EUd zU{00+y#brvjAdOg?XBs;jvbvuHX0#W&0fw5#bB=n78O1};*QFsr3c47^=~=7)j`l; zO|5W)!?&JBLzm-{ao_J{ctUWIc-0OuRf*b5HuocltB$tH4L)7EsV$%8T1bEr-I>P{ zU46h&?Ft#{UDgAX=n+iF$}c7A`2-4ukf6=Ur;(VOw;dT-fVvn$BqPvgXyg@9bUZ7n-%~KkRFa)hoc1X6nC(a$Y);TFRqhW#m$- zZ)!XJ=02`2_jale30mY%7!%d@k9u}NNoXt7Zqkwkmv_{&+0D>(}^Gl;jT$|Q+(-IU&=@MMNEiF20J zh^27k={$BlJ@SdS#O{=&jM3io-bik5{89{ zzsu+}Lqmm5PQE_fsqV%XHsch#p~@_gRir0Z{p&nD=zB3H)A*FR-GCgedWGt&A&`+bIc)PWzRD+KHzZbhGi&Elwsw87pCI zu{b{vPJ*7u9A!I}-zvhBLhg%15o&xcTYCs(dFQ$BOq4EJfu;p%+Y^Pt^~i(SI}{&G zcPhK%ZOLa!UvxjQbGnr49haQJkAprl%SR$Vp!yP(^R1ojgZ$jNuW0}VVd(M8ym;P9 za02VPs0;)A7Pp{i&Z;OmHzCmaiL_=fdIfi)NJhj9s)|EX4wbk_1t|wtNs!7`)I*{P z+-@4u(7m-J`NhI-C=ka@3EiMC*1zyHk)$kCjsbA-S64Bp41oF^MK5v&!s<(Oy38Ei zTnnh*y54>k0#d64uS=(%FAW2AT;KmRO%e+r*2;A*NFWUBTFQ?3pXSLQM#}cnsHiC8 zAD?86M{`>V2y6+D@4@COMENo<1=+=hquC1+}Gf`VLe|<`45rm zTs@6wB}j|ZT}Nui8aPTMCxAj!u=Byw`?HG2Dc5QwOck3vlGf$ z&r-sB$;K9R)!0HlHdSpMuFCYV@6ys#gUk7jSE4hjrE`~T$R(JN6hPJg8>YdExGNOG zlGn?Cf+kJ{$TJr`hUU5V;U>H+j?vR!{-zy((SdsI?Gn(SRt`}deoWUUu5#3N%$dtr zxX<1H>N>BF3PnX#YrNNBt=^)GDI!Xk0i@*DdV2lha^D_3^v2T21H(3{T+YqaR==@} zsy{ssa}$uXN|{jI-w5yoZ6KDTVGNMc7urvh+o+g)sj%*)$n@o%mw*iypWK>a;3=^@ zD{~R(jRUKh^$}@)F?B0hvCNSwQ`5)5IJk_<*`D|7Lp_PN{8ZPcl5e7F(d%$;Rb)Tz zXzL<>o=r0ogTQq3Bql>RR*D2P})o##p=! zBvp~1v5T$^1|c>pgDgM`UKvfDaYdq_ zzt3{aJslilT0pHZ*xFz5QB9Jihg=#Cc{%f_n@9nMrxTa19T9x75-nf4W_3`07m(TzF?dFzrO_0f#pHhd+w3 z3WSe{BS#u4H1Ee!E-0y3B|K<~IQydVR6@&56|kWNiSh(PZ-%ZM^e9PevrKbm*ErvX zu4}EG$&SW#tH_A#i3zR>&@x_69=wlTPn<1_-x8ysefSgME$E5JW!DO=*s0ncE>i5a5s#M zcB=g;$eIKMSkKrf8`f=*^Vbozb@64+Iw)iC1}K7_?qe^4DlBH1?P3_dKCKyN|8;ehqYr zrA@S7eR<@4fiY(ZyLOJ4k)439yO`d)8N+7lEN5;kONEdY9u`}WkKpX|wlDW=6oXKy za3jH@vP51-ryE^@gL0bMne>26r~VZN#(CjP)cLkpaX;Qn0_(SD=m!NglQ=~;hfves z>d)6K1k(gEFqF%v2h{6Cg(L0rqFSb@F238$@Qf(D2c*gb4MyYYlSJO+Y5lVKWNMZ2 z?%XCn;JO{*s1T+eKz9iMnwpS-88Cz_7>_#tj~~xIRL{dr+i?6p%{KVO{XfGfd8BRa zWY}2emMQZLI~=wf6yZa!aWdr6?-PI;C|n7OxR8i~g0*)?S*v}~t5fqkSVNIOA28kO zB*iR={9WZ?EH0k;m^s_E7z1i zikN5BqH;ZeMj>yQ5ltThNv|GF&OznthrXtMo6VgndHe}6*%A2m0o6hEV+u_8L(GSZ z44^!sK;B6bL);KZJP3Tb!JTh$^GCwxm2s+^CqBUII-MQarsc+RwS_3Tbfa2paSKJ8 zgIDXx0XHvv@!KIj4}Ro7W;f@i0In##VHmc}E(R5oBx3)IIc>(-lFh z2?I3WSoI0I?>^hdY_dSB&o72gN1J0L?NF8Y)P{PjF1%)@fa3tpgi)fgMn%r#vl1UD ziJLL245&$*b!}95EXvWXN6Q{@whOY5F|$w}!%y!t+?)EOj*OndL@fce#kdSX7=2WQ5ns+iyxmObRbd?Qz-Xl-a z=Ua%Me*X#(cuMgzMRJxwjQMxii z1@%P6ljqbNJgx=8lZ@)Maxtf+C)_36Ns{M|#+a`%W&9KZmjx7Sl?^Py$}29~P-h$u z^UYa<0}48eD3kVUbsw+Hj2Aa!nXn}sW0msbvF>FvZDfk5n_H2j@aCS`i9AS=aI0s0 z0s4ad;Uw8q)5C_Bo`18^{sp2KaOZ?E7TWX|3;dpv{`cRBvcz;t!)Xcm9}49ui+0Q= zt%jD@@Wyh4h6ia&&I(*vwlZCy{ZFbo4wOSK#_}rHNkmB^XG7$0>qCRpn8m_$6QfXs z9HY?byhkq8ibt`lPK2Qd_?+UJ5S)9BV}a_8JW>J34@T4`(J;)Ik<@p0uDfAcEzam# zVXYG5x<>NfJrs&NsR9+?VhoS7?-K>VRqg%=01%Ja22RfvQ!Rjz_X1a%enAld)Hmu; zBaHo<)BNu@&Vi5Kr1Jx@`h#vMC`B$MROoS*R#Ed=8Uwykyfq<91rZ{Xx7B-8Qy-)3 zFvJwD6;{TJq96uHsc;o!PVg(;>>AYyEo9JBqpTyBYZz8ZkR-oD@hUF+mfIi6)0SXu zRo5qos4>&GLy@JE=qxmy+86nCS{Cg9-Z5cp; zco#z6>dpOY6_`HNsZSpb5a;I@YT6*Kq+_0Lm_sDC;_#;v{37(#E6 zWLU{aeu2ZqzPy}tXhABW_r6dwqpEy%TRq(}$+tOLV6f-j@2p58RB~szf7*D)?gu4H zu}D3t zbd?;W#%;HsDQ2J*2=DBaPx3)$5>}wXd`lOJOrWr*=xgoU9%7<~lMQPNS@*L>xi7sX zV<_q`zU!$8!`NVE@x_$`e-DCB_rg6`5Zc`(ge_LbK>!-2a|ZetsGPJdYb# zcgW%c!gjx8=lo@;JT7u<1qtz&!t%e~%zG^I+ai)%w*ZQA*2_Cnf3CpaHVvG>;eWn(_Y!zs?3-^HV5J{^?Hc}RrE5Me z67PWk@mJXW??Yhc0eDd6A>fUbHwqzBILrQ@rmB1w1;DH1LEVM<6NG zG5|pb;PfT`@T{LMYaKVR2>k;V1jNtd{JR&{&H%Hd-lG~UJOhGcgl2Pazt&HAEE_d) zA)P}07q$L9oSu=u^JJ*lEq;fa?Z`x+pD{ISCtwk+dpZb+|B2&26WEW_N9MXC>uo{= zGR52zb?Cp=XU7A;`+hF`ndtAJ`bka@kYvE~qNMb$fKvA*;tl(GJL$(Uut>wL#^Y3{ zUm*X_*KJ#mvf~;Qdw?(q~zU9Q20zTPgh$ zSBLN56e+bXzbv$U=JWwQK~ZV(Io#}(B{KSjd51^L-w}A8{3MY7rpsUN@OJ`G_Omnf zUxov+#%fhn*M&&oTBfPC7BL&GEvQ{C6|7iI4-`o5Boi^`R z!1Ds=?miR#hnKKCwC0#kH3QlT4=wDex4BsmiljTdo@i~Z{yr&GpB|v6#6CR7zqkB; z5@0tw@H~!DoPiO5*ots0m?s}Was0Nn@Y1QxUQoBLl=%@1+q8GX^1+P!E7{u|6O~Xlj7`WCVY>+SAf$RR`YQH36Zh-LYpTC8?`D@9=;R)c^+V zD!x>-dG+g5f9~|ZUv#SjEMi!);iQxI@er(Y`5FgEAV8u_l~Y80*bmK?Sd$#?8Qs_d zZrl*IX?^}<#5ADJ0xlr`8GU$GJ}SRmSxWQ^m?cK^_bbZ4CbvjYTAZ*6IIzflyWC*H zM~dcWa?J>z{jO8=QyxS5Okbb>BLE;i_CMOGc1~Pp^MFJ-Tluoi-$o91+hWQ@{&MaU zS_c9;LO6lCZ)A9_zhp&Q#-m{WApq>@@)Mk%+do|54{|fi00NJdLtnqi@e>E5T$;?F z9bcT}+U5k0`VDXuI8*=n4vt;}=kf!U?6aQi%e^@~ahAe3GOIGE zH^22Ysy0zRK;?p~`E9~$_+w@{ywk3o{-?$9KlKwpxoxp(s%6*A+rVl`9Vpn3B_bdA=YSB9~PT3f0Pz%L*Kx(qLwEugMQ=W-~`YI1eJg zn?mXE%Tzrc;EGq zjleSDv+Ym}VrcnDDD2XCZ)WqB{Zg3-dM)*HtIt&teg@fJkmJ5ZS$#%6VuFgl3|{`~ zk9>H42Lszo)H8cTo1}t~Lr%pH9|4sO@lXFK%Ml|&hAR&*WZvX)o$zk@x9jh66VJTIVC(z5kNHB^eaqKzxWq)Z-#34A8LPka$!uIW5!%gCGAzm~>9$2sHp(_A_8%DMV1>x)=a%O*RB%c#S=?G3`G99Il{k zd?y11eEFQYR0B~{%l4JN3RbO~p(sr=ry7Eam!P!&&f4&^-w;@!1_?!|a5AhiFdyd$ zdhlEUAmBwg%;yxV5{J(wg`TiL^y#J;{3LzC`7WM>=bf0D)KmVv%xKSC31C}+g}}A~ zso5Mv|NkS2@PU6yfb91JxKkqm&2UJqMhOSXTx8+o%KVy@GGfsGJm-csy3#oH5y2l7 zOMovfxIWyGT>!SVwEN1lD=zewI8Q z-aP@(YWxJ|qu)QEk_bw8*jE`Tjy9A!x!}xG6B!CQM=uin0afozSZ>lwvB2LC8^Y5Q z#EF0bZH@@OJzUbUw)y@=NPRXlw2BnJ1fWEIFG~J4J+E$w(BCNLog#qIPzfQf|A$&0 zDM>y73JTo65`~a7R$|Ij$@GjH%Y+FD|HNs!pWTG`x1)ZU1ND^qRn9f*L@ga;xTMOS z&+arn&f%tTTUKZ)1v9=paXAM655`LGC(Krg-j4NLKPb6F0cnW!-jhBHPM1)`x|6s%+;x!hnwoFrU5aCMH z;EyUjf)i;le?VzP9y==P2T^%;{lNox1RRLLza8po5pbwI7gNLC z;(yObkDH-Y;1^ErTTZ~?wUXQUzWKRau~ zc>5$gb(RH!tMNH&Mku2{2y`L;Hv0^m{6fzZ=bJw=(T^V)WS>n&S?g@iaJgMyK-SxF zc{^^&ABtB~4}B6K5Q}~#Z5rvlE)G8x17K`sY)Ne9%M|<}<-JYh>@?idL)Er<% zDfN%}j*o=Q3@ww^43+m?i{uC6Fh*WjaY+i~$OnA>hUWS6+KM)f>)dECfWc$WOh(aS1UI081Kh+wk@6b)8uwfU7K{NRH;I3^ zzhSt2WALh2r*(Rh-_?z#{esNj7Iws#WJUl$)F0<*c5FU2;R&+;&=)-m_W@7>-1POI z#ODip6jX6pfUi|8_QW~_@3*tCdoVsV--7Y)K+l3N5QThhv^Ut&+Ith@6KzB<5L(Fl zw%Gb!k;x;;_*fC3(Y=*(X6k3JN_b!n79Wb#{*SG&tI z(D|1@*T3N|N?FV^ZP*~sm$);6`bZD?dMlsAa!sf8=l?*WDrGzUF}E}`ciHEevoI;N zz6!Qq@?$#o)UpyL2o|FP>qB&dA>K(CXn`QVf zpzuvyn-;L9nU`wic$}1u?RR18+I})?--%2oWirf*aMBRE-MDw_y|*k2DVN0StZR_^ zH}eFjUxWse_TFj?daxCHjTd52TgCnNAF)q9aHSavyGD;5v*{fjCF-);7^tX=RNbFg z^O>sqjJcj1A1}yuW3OrI`qA%SbLLTz1Pv0(G#2i~)7cJ6YAm92^K}+ZLfpJp8ooJU zk7e@XYd$r~9YDs}Ig`$=f_$!NAnCk&f6uiZ8`FeCmRY6>VGv`?Ob;d2p;_6 zQeu@`AQ`1ayYI<`X4KVVQu|UC=lm8MR{Nh}614zkO6wpYm~w!M%o*RG$Ve*p58rzh zrA!mSOZ*C|*L?6QnT}`HOTUR0H*?M!6A&>Tu{!O_y>{f&+XcWjzxUr!FTRgnIPC_L zPCE*NqPZ$HMf@JQU90auE7wu8j(6GXEV}v*h}+>D+=i0C*s8Td3x2nYP#p60#gEXw)0V z0r(>^yvhNm0&e(HoD6xrH88IA(=VfZxrGUW93`elc|G#&=-z0H+^8EqXnGR!QFn(| zPo5m$_^%Hit^b7|*h*Rvt4I1S(I#S0jd=VDS7HJ0feiE0R>>-;RvN!g1?SYAfF4>; zMNW5NNpcBuJp#RnjDI^y{rOk;GE=F4_4iQdHUm)n^V>o)rnJ@9xH z{hCWrDu?tlHrHj%vQ`^*1|=K`-g4<1T!3AwG8M#LALbCh=f{rN6Ef{Z17R~-MPl2n zHjwyd3n>wrO;oU`w0=c5zdx9<#9JvPbLcg`G34E% z-~Ln)^1ofTPRJr`Qg8Ny`P(Vi#0*4pv!UT8uaI_n+g+cp27e64ce*}fMa{KlLQS(t zasE6q9py$0f3je3EHM;D=rnG!M|?KHm4CAW(4I_csIncUW+-gq62OD;v~{fuJHLA7 z^6cpTV9J*W9&)_dBp|;yK@H*ZWIgYvG;dZR<6oBnHrMzk7|$)1{&iPB2l zlhISILuTbB!9#JC(_VcHJ)8VvfIdQcE7U}j#;{vhWBGx+HVE$f34_{Uc%%S&g)i509P`i5w0S05Uy3k9jJYz>%GWP~5+X5D!AbwxHDY~) zNqsvaMTl*kRW~X2gPJ8*6VZDc=^L_Ei6JgRJm=&M z)`l6PAaSp|Oyu}R@|*pH)gtLFC0WFvDe@cF8e z<}*=L4M9s%MKPj%&@{e=oiV_zj@$a2CUD&K13zQBDwCJ2$DO&gZmr5Q28O2lzlaT3 zto)K}2HON%6hgv<8KeGgLc0OdxZ%TNEGH8T1|`;Lc!F_N{XH70c&Vwq+0yL_$RFna zo+Jw)WeF%zFyfz*^J>38$CYaKG8Es1w|FVCzt7>QRFktsm$`_0x**=T{FsV8l`Ab? zY5D<(9FI8Z^*!R>w2UxS*ZS{H`}#Y|*Y}fu^cJM6zU)fhT>TOC{CmUQvg@qyx_|66 z3@m@q`15-KxRC_01~d_yOc2Ah3&w?<#`etZg-gT~0wd((^HjIyL6}m{jpeBdK9^cr z)k{d~#pAo_`Eq!H7D|){q+Di4sJxm&zBkNNh*JnBtF4&ajvLbAuf*G3tv{8hw=;bi z`Ev8CzHLcsdb-AT!4Tt@QBXw0APi=VZ)ljU^79=x^U)TrbwRgM*^%jUI37)4zWgW1 zn$Pvp2J?*6+3)_`cV|CUx_otN1kZj3x3MoXp}$l|tmj1P_LQfinqc{}cpP%icL!}A zb~anszu<_K9iof)F|61bOS1~pVDS=yydG+AcGYyrQSh^ZM6Y{$QhMoLCv(hJ+p{A6 zMOSCsn4ZM^0hUg4)p~AK4h$>a&^>sMGNWG|qNYD_pKuy_uxOh|2p8%@-oI^HPB1v(r#hQ2w79 zOh9o~H{P!~rGw|lbew;K-qYGI$8);&SIU+#64Sy|nWa9e(VmfDi2wmTsg7_ym2d>uJBz6haq#M^1g1T)vQNRt)qFm|?<&-K#=lQs$NeIlhVc z;Da*+9j*UZz<#2#>2qO55pzFP(B1Sh?yopvdGOBL6lk(b-1u*+3}r4&CG9NL?@i?| zG|Syz!;#%paznzYh#S)ZSo-rVx4KCx{u3h&G>w8f_?Rjq99pL}aAN ziKiQcL&jTN4^gYV_}W@kjCOp_$MRi zZhjuY*Jt5>JCcJk-YRb0E1cl0oY1aVb_0MPwy5%IpdNlcOc=E$s?9vOjM2q~v{io6 z2>N?%!INm5eDSl!*Ywq|d;pFOFYLH<9?4TVM!t40>I>kmeLH}xs{KRcDqMlZ{yO+( zY?B>_kjnLzj&hW@#p#~KILFIH#7SPvwW2=Jm={3a#UqJX{@D7dxsR(W_U+*lB*>Ve z?JPZUcDaRDtCMH}*rSS(X<%yBlK@SQ7QLA2?X~87u;!!czQa=Hq2-7Xz9*ST47D}L zcg@yr@7roPnl-@c-}-yVPHgHH-DbX1<*RedyFV8&329%-;OuQjtTWHEVi14sJfFPx zMspn46HBfp&{+sWkT(`NU4+NeJdx+cl^C(}IJS`TQmINqq2W(fy0}YsPhybCo`#{j z^6%D}v_{rDjfHQ`&K+1=2JQD$z`D!TvB#P@ey}yVq_|BzY0T& z4ZUtUl^?&iS0JxXb}o4~s?p+vbL7rRv3Jm}1>pOWPmY`vrXqEdj*t%bpH6BmT{_>W z3AJnH^y0XGax#0ouk%r6&*}Ie){5^1`0ek1^GgPD^o-Kpooj0qxSF1aCyKYLzvnFc zN(gwi7I=-)fp1{3Igejw7WG_gW>%suz=`<~uOA0SB?Z>_Ky3XbdfL_z8+Pr0o2yt# zpxGF-Z?L}#J(F_Xl6&)UlsCYAy=f}xbm|6jw-51-h{dGVI}?u@EKiAN^&}ZWCjO-> z!#6_zUvw5k8hyF(v{wpCa95zwWDOg~HiP5o#`*O_>w}|ViSyRo*z^dla+WwM;=*7M ztCkF;TtlHmJC7=f{RsD9<|v!wAG|}PjE-4 zZ_Hl2e%?O-UBD&~WFBVKW8pnILs zszQe^=_Hr+g_Oe;8LH7zgXsY;yIm^ouy>>Oy1)9vB{aJ0c{}piUC~kIifXBcy_%KJ zMjIcL7U!%aR24u*>~p2h%IA8igSy@<7Aa>%5sK+rzh&#e8i2@%3dV86^D?ZW?hmwL6-_t{yXWQ)PIp{g5*8tb5$2_~cq}*Q!!0PreWelP8 z8%YWS94`s^%ZquPCp9Mrua&2=-%{)Af2C~jix=kcKQk9ZckdJE==|8zeSFF&AD^W% zlCQo~SJ)jK+}Zg(eDZhqfvENYjR%a1i_HTb8vWsUard-)JmhzO)LS>}P~sYN1n6%F z%{OK+qlHb&;i2IMBQP_P3AZBkvhRb`bHbA2DV`99AtSa_a@3bO<>JUcZ{hTZBoCb? z@xKx0Y#oHqfa2(~IPJkkb9GIkP82$2TK{0HI^<;yww`1SHZm)~quobZELe_k`}W|p z9^;lCRjRKFfISmbMPN$V{+rKE!e5?vK~Lafd=k0wq#pn5p|#Ubc#Hwt&FmIymzFCc zAw{!|^cMRt{%WuNuBP^{jdpLYw(l;Oc5LdITAh~3ZL5S*+H#3!<;+0HkgB;h34vy@ ze#|c}I&}Jyzs#Jg=cy3(j7GKe4qe1R5#C3ONH9w!$DD1y6+ltxcCCa2GPohTo=|ok z6Wf{OW@}16hBtFmlE#t6+xH{uHAJy`VLgzTL0&U?aY(qcVPa`Lk$B3muvRzR&jz;> zjL;?b`=f<&y{oIOH5Im_nPfM60d4(cUKOTWTHxbu*nK&9e{)iR1gtf4HlUwvF}Jff zFCo&(QFm20;`~4toBVuh6snWKaV}=o4G+|u!+u*R$0nSopO15|75o8URj>Jh4W=sI zz5DmvoZ!SDe{U!u#c--rlW?4c{>!5IE^>?ibLg&rhkq*GorZ9=Y~IAo6SsFfgeQMF z85vYPu4GAu1v2hY^>>^v3$D3Etcp5TIq^Q`xQYg-TbkK{Zs87RQEx2xKZET%ntbo< zf8TnpZ#CYpeNUtjO_+ywJT!hH89L3>8JX*zILi)ox*9?Hb40ai;Y#c_RN{kFu|TjA zaa0R&@AJSkoLoC14VDU^nz04m4_thCx*FxmLB1GxDP6AKT~*Rd32oo1Y!J;lhEJSpn}3uuO95LS1_OFvv%0Fx&2M?LX_XgtP9yy21?>nIcqH zo&&ka40V!5F&HmND`PVkV6>n$yrh9~i@SK<-cip28;P7)Ubek&6Ip_C@BZ}Mld$9@ zkCKXz4SBHCK)ZPfRRQ}LCg^)6ow#dT4jD(72CVvOV$vnn=G&; zya^X`!Ji2zUnWE2cbP%g-mZ38>bqOia^4N|2yJ~ICC(jS5kIneiMufU%?{qX)iTl$ zp~81JwvxP;XT7?AB_5TS3rh7JWB+6oJ}A*{CWj|E;zv$dPUTN7`c~`po9&Swky-JR zmlMMqcbYpBDZX642EU6f7~h5AsKr&qG8YviCBStho5dAVP~wm9H+BaZ1w|)#d~Ju_ zA|Ex$JCbdqrqYjzS+l^a#=wi% zUtM;Ypxg0(ed0m>t1z@)kb&fepn9)6{Qk^V5r8!4i=Y>ux`jO6z8WuVF{d}y$&T&M zbd9^b+?fqX`Y9Cm31lFY))K#_-Uot<2Q75IufrIqqG7YeL%0tJoZ|&oM8VfP2{+I@jTzuJkEVpV2yfCd4X|`n#O6h3mfrxitUXYdRYA zerQJ-jR+yIyvVtFyZ3T;>sI4?)?S^!xfmk(lLut~Z-s-)2sz~VaMpH!wZUqgOvLR0 zB`!zkMYBU_@BKBKDXI(RyZ1jOkv%RblRu118K109faAi`-fER0asK>C{2ui}x5=&y zObP^|r_UtwQVIXOXOF$-F71(V36#f=529KmI?=`QrX70oa@TRGAu5oTMvBPm_|RWg zOy34M{^`lbB+zXB5RISsdwNy2yopzTnS)~s7uo-cyBT^ zoJlmv>%mR_YPG|eWP3RO6s76Bnx88%kd;1fzH5wxD83p?EAIYDzX?K*S>5h&Dia<@ zlht2?>xy!D{`SQ}^+r$vfk6Y_n9nWl)$}%}!!Jhu)j+{64Pm1VC#BOI#%Uv>B z{?Gj#2BLya*YdSFDFu>h2&iwSMuSXwxS<(17`uY9$>>ua4wk1B(XnDKkVJV)Ky>jc zrRrDUgf3n@S}bGk&1}PGVgd-m)B7uq&q>V+@UG7Vg>o;o5e={ry$P*C+Nye`BDjNY z)00uRpCH%%%^%W?f23WBHd`u65p7a1Bm>EK7Ku;<9&5Vk$4%!N#GykHEzIg*O7_7O zMk9Y|Ol*r9f0hN!=DjAitikgS%?sfDRP)T4$&M1R!CNe~X(*iD`evT98b^=)-35YJ zG~y@W&`+Av9YG>Gk>Bgo0f@X4<2E5P1<11%M;ayXnWS^$%gp>_eJvf7HVdcPrOUlW zb=m9-$(=;33lOO6wI;`|JpenDd-T)hTTB;$_)>eAK$r?!P@xcq*-7$YEA2jCo{N{{ z4Ixq3(39UF$xW&4Wgng$7g;5hcnait0q&5CAuX-Vz9FAY?ub$ct zZp2Iz+uxgF*=}ZsZ4UWxrzs%WYEP-bRIT+JO^4lBppk!UiGOeP?Gm7r^Qr8WvB)%) zRmC_6P_<_S7umFsQy=|!z9HCMnCQB6!7m6YxU(U@&7`QXFFZ@G1ROfbp66@_WIO72g;*Siat_L;;o*G z+)rCCqj=e}2NM_hJu^c!2Sbz-c^AbLUV8!P@w0&FSh3eifZMg4wPv)48v{K@$c6rE zTPhr6P?Ugt!`Uv3KJ16wlmzb6V6NRa1o0lo$%J{X1Uj)7XJK|{`KXE8W#q1gI8UbW zHC$?po$n3mD{eY~u+N1o!9r*uVk;s=t zEA(Zk-+ngZcaZzXK>2BmHV41CM!}7D9s?=tKOzi9UIwN*Z@uZcqJ9G58#LWr9~Fi~ z%8`9te+UJuFfgI1SWcw%E%eJDHDw941jAvD7Zz}WMbnL)Q7vKDh?RZiFl7rechRPh zZoxM9qkPHIeb|kC_c~y8y0atla-nhqty?jBI71rjvN(nOp9)Kiwh;lj0UO?B zUKWk7823)9Cj*O>vXJJ=G*$IOWTYJ+U@3;bV0$!DL9Rh#mtO_Lyu=X!>#GOH_n$-& z(Wk+0Q@P(J&eR{N7k+-m#A7(jeds3fkaK(X%#nwzt@jurPoAyETw5t#EL}_Aeic8o z@ulp!5(OM9LZ9$7=8FON&6PR{JPLuYRS?YBYl1b+_68D|>cf__5agyE>t)GI+X$D)Du={ySt=F^HAG_W%Pe3k!qXQ@_($F!#}S z&m9*s5!buVcq5gIhYj;2BDJphA4s7UC~a4uET0}0NOS5)Zxfrb!ar#$r^ zBEyn&B7zgoyZQOfIJ>5dRJ{c5?<7BF;Td@kA@hE7w1;tbxj?3dvFuE+9}1DTjg>>b zdOsbq<6r-Q!o(y_K?w^A&l^wkXuxT7yA^yl;ziXM8K7CY4LUNEq- zcy$+hKNvzNf?+CMV}Fo)_+!GK$4aQiivqHFir>V!0<41&#g+)pK3xv9LLDMDn0-ggF=qV9Bki8Z4`jSpUO`?d5Q z%S9aN$^;M2+)WEcdegh9y8xAZ73F)nbl+ipD+?Yx?zp$>8}x~;$RNYyApD`Yyn@}+EF`PYET;9_Dy?HD#!3LNrQj#z5f_H5sE`Sz@$V~{NgnpB{v2N3LdPRcG{=_&1cR&)aQZmt-*AUH0Mq(aa^EZwm9%RxpDh)*#)cpNB={r!wySm7-Tp~l)q=aR%#XU4%?^~{`5I912^KsQv9>;%ereu;$8md@7@ z6}lygNi`Mn+0tZALhyEx;Pt!QsqbHuVAEt{%+QDd7`>}(-`6xQKpj%g1G$Fac0iko zt^`+cZOUgHD`k9xr84}L3FJ4f{4$nu!aCR>3e?gXB|v2?T@&|k&D2Dq2N{-U(B8F! z28y>JThGEA&5d!Mn2Qb3UJ}yhGyVJHc53Y7F!1N1=T(t8d*dNnS6yh5HiV(Ket%ie zafOkQSlCegNN!FecM>P>Q=VA6A=jnj;fu9HlC7g%f8YCiRRWXwPZKsa1bCFt0#0L& z41|qI%~+t-J_N1XTK{|dMx;+@hmoxq3s`=ML|u%DoIsqbmF~-EMKFDU=}A2OYmkV< zPt*cU@4pZHvk%H1j#I^WxS<=J|aZq(sy3}r#L0C(==f>XX-UpXE|UK zQG<&XN%>bFW{MT9fy=i8<9eWi1}Ck)6cOL)S6zRqUD){6>Kv*8xD>(U|Et51F!8`@ zUZLX8y|^|LR(ui_l)gG%x@l{LZ1v>?fOYw8;Ub6e-nhDOr$QS`cCX_XFF+$MdYv{b z#B2#hV(+@xq3KxJ0`@=e+tvE=2d7G$Z4EJGbgGToGdq*2pVcxff;C5|glLw|`=xe{XlsCq_A1LbXn3eLg~7(T!KC-49{fJ$lq%ro04pyj%TM*whr4l}a~W%)Lp0g^pX%jf0fs z8bWR?^*FNsbmN6>x7?AnXTMU1k(uSv^Jm3`?b!WIcK8W&U)oOL<)e>x3Yal^S5GZ@ z)V)*Q#In7hE?f9Q!P9(aj?v;=7uWx%1f zGQOR#Cmq$@*i5S(#NBE`KydrLfC2*em$cKsH< z)lXe#OCJ=9MP~W~nyVq0EW@~Qwjm#YF}mjU_j|aB0e|nOb#w$Dz@US*GFeE_^wo@K zQRq42t;+aJ=xNGeTbgj(&z0QT*Qt**GX?ZBXfntQ4Uwh)lrEp{vVk%e(s!;heMtzI z(-aNQeNW#|y*R*l@@$(%L+t9TQRf)e4Yt^F!`Fnjz1yGu95%>CZ;mHst%Zf(HzqenCCC?gukA zO5uCM=5w$Tey}`w1r%>Z^BP=~yw;P59C$E8PLm3t96+p~32Rt-6d&o>8r()-+}}8$ z6%wWmypBhvdmlm<%ZR2(=+GCE*G|csMv++Is2?AS1T-he5p>vwQo&S#q(MUi9m*Ru z@I4g8lvA3Sc}(c9PC8#SGCb<6z*xqmEN$Ov3f7Oe|6PRtYPiYJl?=SswZcF=AU(q$!5^>eQ)$J0|!)f<3dNw zUgmTAe$De5_y{|0HI}R~U%;c*h&12+Hz1kyTWThgS)VLn(vi1mrt5u@dmNoN-oNG=WY)Kbd}E3dx6UFjW&0+1oO8sP2uM3N~aqLas|JaF7q*d6o!+Ulu)^-33>Vh zGj^QJuwUrHS^YA_R+KB_!)L(iOe3dUrrC*CMG?}F(ij;nL*bYtu9k#yy3rAm&}fF7 z3RDUU?5q#(d7xKz48@cx-*oulOR&2?`g8mMJgCNvNjI8-3DeBS5lX%r%QZAL?*sW@ zk&^nM4W2ErPRJ{Zqb>|*ys9>%5o}f#C{65-9Z=hJfSE>g)X;oQwgpsm*_*N0i?$Pb zgZzIJ+by-BRvC4pPft&?HPj1gFdL-^|JM9{J^P`n?V^y#hb8w^P;88%qa--5fV-ff zl<#^0ea!lt)9}l9nYl_XSac}C2Z8lrJ-&+Sweyldqi^@6BLW62UgYjZL|JhN-k47OcCnL7P85bB)LV2}Y zR_VR!4==+w5^?}*0~b^Lcxzj13Y7utm|Caen5oBCH3+e%zRcg46gf;rp1_R}C!bAC z;rf`$J7)YqwW}-OKnrypq!e60NVmf#KGZ zA$JL)?I+&7_O?jzpYly%(JX;fTmu3-AyaNybzZlf@?jRWF|8CadR`dw)NTD4$$`?Y z@|OqAk$YxCyEVW94o_G>ga^FaR_o89nZCy?pzi=7>CKw7)i)$^)syI6dfjwlf_SR~H*}ve<<8b$7Ot*o*_-64wfB+jCLJk9WL2;U!Sc z7D@a9$#>fPMV0w&%x2ElWS}8(WE~-iN;aSPCEM2q!Oa@Wx>na-_GC3!$99u39hRiV zrv(>0pZL{SI)Yzn>Kn+}A-Sny3hRjC0H|7qOE>?@c{?aU3ITVCf*#wc15y1o`{3pvbVXj zv-cy-8Cv^R!{MAHb6p7YTsCLV94=hEw{VfXm(`Q%z@;_&_l&0=VwuCueF`c6Lbo1X z8ebyXLr`Z?p@t@-Egx#2(&Q|Q0X$28+f=PwqJ&6>EG=Hj^qUEXNayzkd6CF_a6b8J z8PGId;S1rpJ-)SR%H!a4#H13zE&TW@EK|9yd$4p*<6*S)2Uppu+*ciW%x%re?rkVF zPm4r@{Y-B~UbEF4^2vH9=59z55cGwZO2{*Z)|bWW3W3`t;0Gx3;OXuHdgdraSD^Lq zYKW+z^&~yapsd7jj>Og-{^x``<8Wt2?ob6OK)-V13cn-5`$ZMP;>&%XXA%7(z)k`y zpa2uJ-by(kxvnli^0MbuV?H-yLwpzxSwSOlX0RLVSTCsv`mVC;!@@|Nl9dF_#~UYpn}Sx2_GkNZS?(nyUfYQA*&KWZ_+BJ z2q;5u&>ZOU8OdR?*H+ZBKK!SHPV!WjFVZhelosO{$NHWgy~m2Hq?#LAv)#&nqTW`Wg#T5yf93O`Q(TKbr@@o~Vr-t9_=G#zv_; zc#(Gz^w7uUsju(Vs|{|v)%Mf;JytI!=2!~q2TEXD4iWQYOel$ezR~V2I}@3T^{lO zsP!*?Q<6G8)oSplU0${+i3Z&0_J1)=*qqcRyBvc$=xYf0>5KDG%i3s0TbuPTZCUE& zsF!<|BU0Kro(}{(Xr@val&X`<)D(OmJIi|G0|oxa@4w@f*S;&c-H+52M?=QX70~HF z(o|X5;r|#WD)PG}(`5$@p-jq!Gm8Qo^}Ao5@4E5pYOYTgpBfAGWHKPUL|iEQ1K+`2 z&d&&-znU(%%kGoj?rmTw>*vTfAD78_-8~q<`(^xx?7GrXfn?o3*6NFM+DprXCJa!M zwISv)PeC|DrWiKS>9j+`8kvuA`Ojp%%S`L<8c}x>e?nh57(Fh;{=zdR(XRC8%Ps|X zL@a50D4Qf3o(1`%gw2piX!mmm;HHiMvRkma#3RLo;V^tD-+Ub?kVDL;`#9;h zU@{`Iwld_546I)D!?5>XpIk|m67T{zrw7l2q1x~FTm%`?6LnwPi2{pA54GGGh~3a> z)vGfp6>r;q4hi_MKxGDyif)8Jrb0RZ*64%kP5*>`@n9V@7t5NgW9%Pfh^afTWM*>^ zXm}{axe-9kR6UoaPFB{A;nME|e@$`dUmZ+lCJH2#&anwA_~6PE*lIrv+e4VC z^2ktMk1L#CPGunHbSfd`6fLi~>;eIIGJ7IZ%?b+psz#Wl1MubGQ=d;`98Qc0byPf34V3jyZz$;UI<+_zp;cJ`C^wZf&YhEGHykoqZ5Q74rcF?tOTr6VBp;hRLH5J!i8c2 zbCCg9{RMdKzGtS#kbLmtRH*G$#jwS}kLd}#uY2zEZ1=n4lr4}uu}S0pV9a3876;X- znR+xf9X=zwANuqJe@i#yJz(@PWyY*iC$w#5Hl8g;SuNqVY^U8RM~bbF0hCR% zr`nqzFOR(nHK{Atm|<;kU+Y zZp*=pu}xKFkK>Qf$FZHHJq1LXfUJel+cgbWQ0s4Mxzv1ba<0nECS2%TnD;jp>>iO@ z5>@^-h=vpq+hDg{+yXq8;}>rL%d;`HgRo($NV%WirdWKtIA^JhEb-!TWp+2!K2UjX zHBIDf1lWhnqpupYj^-Pp6H%Hfx*vK{d-=)(5)gY>T{fFbBT{&2eeRDXm z*q1h-S|1RKO~OZ}LCk9;3y2A;2Aq&I%Bgm~p(x}bAhSYVTkMrJD`e}}XVIks>b{7eBNKPPJ&n|d^% zq^9StsAg2a`+OH_L`OC~uwr$2nwk|fF7HOCI14dDoCyaz_@yaNT4NmiDl>Jge?VBI zO^&}B+}M$O#+*`l7Bh)Y1^#LNlWKCXPGDGOK8FIA!F-gMS`>jZhhH0rZ>z(vra~uq zxb4RcB9TEHt8OF~j$K3dIX$#%x^LfW0n?7-nruR7a`S&u1(B|uHO25hg|!0?7~j3O zWhc-9c9*)5zbqe>TrRZ$H*lYdOSUWAO9}B-Q6enjPoy08c)_02vIPGE6sEYs>>EZu zZg(-!oRt`LKI-9Fvm*&-euNZYz>*mAr>*Js!yz<9^)4AlJ>Bydz`0<_YgJHpFo(o; zyZ?zk5E1g(JHj#x5Wb}85-*Wuc}2er?~0v>$?8dY&w-Tx)uc=Z zXdkO}ZvJes0R)-MHspPazr}BO=m#1#8~*kwu1~mZ^gFjn>Dy9qZ0P z|LO&~#gHYJo`2T;wE_x(l0j)8nO5sJzXMpZ3!(U)(8n;H(CFZ9 zN|kT_Cipgt>LBc2M#dW1v?Dz+CnDXKC$YmuAejxmcCysZQFu}O&JIeoF7^08GH!8P zCv+tI8XNP&nPMZJk73G+@EiBM*Ryie=ae2c2iy8hgwekjK9@$b{?AFwxzAt|FifOK zxV}hoXN2UYO_&CsM$SoFE$PwkiH%uL^ZE3NkT5=1seK~qCtCcu5%JGu#gRVAxFAhv;@|KhSghcZDTwIr}JgvH*a zr%yryfx6Zw-UDrZF)IWnRfFd#C54WD8!4mvSjG$C&^{p>R?6h(_U82(l! z@U&i&8eaE`V6*5?pi0crW-6!I@(UK0cWMFgk=zyQEtKnBe#IRM%;(mKfML}CWN==P zzvscw?DTm?)_rKecaVtr9b1Bo9|C=lJBHzfVZC#>=_)eBGHbPTr5Zgn#uR5$5rOGU} z$oShcKO|uyZOl1Jkpq%{%(qf$$i2TYt8RNoE2=M0k%rIYSNJS%f)E$E8!(bM(q!tX z&C>VxJ(FAKvs(#Ycy34ves+`I$J-QD{FBD|n|U`bLP0zw$E&@!B0Jfu>%lp>RkrEL zE9bj8z_Sm9h)i*5TOv)Z6ru^IkizT@2%>@8-FC4X?X|cZ;k(gx*Kbl~cYEU~4W6n_ zY@sGnN;i$UcZebOk{hJ>U|mmc?FKBG=!e=bpRg1+2*&D}TuqlX<^zkqlIsWD{N<~hd6mi^)jE%_En(chr_HQpTljMEWj?yze191C}!jnfSHV&YOBN~c9VnnoIrZRX~y zRAu6~?70vvft6!OIrO*l3Rjx!hkqWKt6W7Uhd%3J;5=!M2~PKvEB~47H zX5qc{cLkL9=gPZzU!PEGJQl=#r>+S=;aXJGagTMVFk*2`z`z z0zt(i+FTW$wVGCg4Ffh7vnq~f-ySC!dWA`rjc>!vDi;n8^vNq)*D1JFRNRsy{;PL3 zouK~kJUBS4|6HUO@zTN0n(vypF;V`H zUlD~dYAF5uhWn6Aj^=2+wlou0mm^h|@S(4sqoTq=rdnz)%yS}oiOc~sx^n-ISSZtY zK(skNtDP83d|>aMk*lh)%)^uIOq=kRu{6RegLXVok3WI!9&Q2hgQp$V>i(Kf4mKw$ zL2*>Uj+lVG{^`=Iqblk=Q}iooJ{(NqmtU#<@BIjA$s!Lj#Mkm%iaBrE9?tHA`r+NO zqn@wA`cIZRafn$BlNMx1H!4@e#W^K0ja<)36i#R^rVeWLTY2DtkB=1Hp9Jhy%f@xEBkk!{htREYBg;i7zj527(bsZ6$gZs@`Jlv0&9mXbv_5Y z^+&^YGK#VGfT&(=@u+zvs%#_T;58)wvmw3QMT*yUL5RGd29_#@{RT^Ezpg%e#l-o{ z;AG@BLA~yW3NC=dfjN@p5FEcL&^XM=gsSoHYdhgr11n{_>6HHF5F_2IaQtsmZg``| z-=!NyV1SgwO**u91Qf1AY1x8-Q@CyBc^~uM^S~p#&eDSc_?xRu+)na;?wFu5SQvD) zuiu2oF&K4hwv8+gnJZR~!d0Y^;%U+%5MfvK%;za~0t3{!7f>0qG%H2j&0P6sFKhxk z=ohxJI$@Wdy8*B~f5c*ZsQO72c5zINw$`qq_m3XaH1FDkHc#b<25x5J0XB(#!82`# zFDB;oqKCAss&ZkKT$6~@HB}--gf!_q-Z2H@@Rh7=cc?Wb2a-rzRD-iCJ9Cn}M3O`F zKck-HJw+(e3K6`nB>W>tpoB&`H7y1ADJgiu7dj;W6&bigFfNqb4=7=uJQ4mXolv2#*e*7+Npyn3whY-h zL>2V%w9p^)VGv=q7|RV_+c~1TW@r%Z)ME_3u-<=;W4-ooBr4#K3oV40k)ak+K4N~L zbW!g7=ZfdulT{QtO@`Wl!=s-XLvsBP-gaba2JYd!w&~VdCe(*BQRJECanR;bTmMbl z4dgVd3SdFP$zUvw94}3+`#-N%{3o($+=Y@_tsktMn#ub z=AUQz?`KYQvfeX1ibXAC9>UoN^K-yrlV7Tu5iUpWw^NrDRkeV zKz)5RiJw$3FRcT89et%2MT!hfoaqo%v@c#bTAJ-f!Xhz9ptd#hlQYB@D2kqGgbtWKW1aw zT}lA1m+(I7#cppnT^?nE9+iSolj6&%P&>EzU(RT3RY9z0PxovAJJ?qT|$Ee+inNFsn>&3xmt* z%}SmJrG>|MfD8b$xKehP93p~jL>m)9w6WE22w_+jiJ7cNdsyqWdp@wA&)xIrqs&92nR1me_YhiOJe5z z7C_0|{}mYr-XDtGEZ5@ZQc@=SN-a}eK0~)Fw~%3QM8C=XPGu6>|Bbra_1`-ULjL?g zM+_rYfz_rt9f(bhAx>u=`IJ?Rk~sWBf2P-vO-RO`Lu&yfNVkTf=?td8H~aXs_7;t?62}$`h!1e!?=|G>NVc#Lb&eaq+7guQvEU=u1yOp1X03 zz&eT6!Y=An&i8Z{|72BkwJ6t)6>&ELAU!ug9E4Ah3R497Q|A9+>??!fTDzPnicXyY@`3_fR?$mtq)~)Iv&~$Yj9@( zcx7vO`JFGOM?i(B)_-T#9b;R~R}9k+(DD!+{X;qBZ}FK6^eS-E&u`1e|eq zS2j_}omr*q^kndSD{^Z4XyQ;e8LN6L4n#BfScy+D#8H10`QrV}Ly{j9z{MaTo=k}I zJHj|62fal#Er2Fq)N-WksW?sBA@3j?SNX!QQN`hPW65GCuu6d-xG?6{HhUGhJ+ zuV^oAG;-LDo-&P;Bz0sPYqfqOvYJWk}YW_qhAU+=xJ-bhhq=9kdp&R&RMBppC| z%XQU5|4P7}AlAFFuFgVJ&GJWih>@(RGIEz#yI1!8FuhU~zc^fJx2IT|S&)&w@=WnJ zV#=GREP@iMd3nfEl9lPW-Agt%kUJDC<_3TMH{V502XmyoS#BDhcRJnAba$wh%PqMx z@SZy);$hFp`;eJn-uQ9|`!^UXtXahHa!dJ6PCnLiy1exDC#L}dA@Tf__nPt10O8$u zA&;HNx=>OmJnj41&=U5&Tr+Rc;5Z9agfvi#O^_ZS?{Wm}p#R%Ye{opSObAu0S8LXj zykBVX*PBWYf89qLErt}`=gTQh0yWaEXpH7Vw6JGvy@VWI0qMBe@8ty?v3d!l{^)zhPEsG~p6wr7;;+LSo^5BD zj5+%+m61VwMjUIR`FnmE(^QyiE=qh#k9U zL+Jp?6)5|0rZ~V4E{?#*F;O^_s-fMno-xyGO4vdW*c{{juOOtn)@y4*Xbfs1s=#1+ttLSULkWc5fwllEO?Jae1V(wuA0EUh})P0S) zZAe4$CjZP$M6yb*B&A$)#`azJCm7HG==Z)W6c$!+1dV@qFQCVzN(|@={C8ovg9|E+ z*Xwnc&`fyG1;q#e-3Hfi^&Ovi(eeg2(SOXfimBf4U*n^nTQ~&Giv{TMgfV!Oq;+)G{krVYq!MA|3TB zZaWVMgns#^=O@vINk@Fggan_wasy^g%9LsPq_sk0ec_m;g!pM^B;`#=A-+ZwfpHqR zwSExcZy{ZU4+VH`psf3X#!?=sylD|b--1NsvWGohgxiU%?Nr)dG@fGm3ZMjCQcId0 zOW(WqmjvsPogd7edohWR4i7Wzn(qV$aThB8Y|xi+?8WE?sjo5$4HH**s=eBD1ii!h zES36`I~wJ#Xb>n{2eyz8B;bPXZ8q(A$Yqd-$6!@XjDdQmM;h&&aLLv^_yl{%lTfqG z9qRUCX9G-Ob{)!qkuAg_G-f_m?QKSY8KRE5(&hmqgIwQt7_yXG?WOy=_(x*L zCY{HqP&Di+z3fd`jKZ8X^;*RfKP8zaT?4{fc|b1qj@;thEa7|arqht|Z-9VFtquRT zv{tu^@%k{K-1WhJedPKgwnB}|--=V->jH3mQ0Y+v&QK3H3rPIAd?clT^~;+PuvrJV z^~YaE&n~3@RI5Upt0Dcf*R2-Gj|?D3eYaGAnbqd|V(_I})?LG0J5a)x>AkuPg+1bZ z(v%4x1|f5^$G0m7?X0eUY=U%EglRVj8{Jmak%_bBoD0RJOJIecQoDxFdwigre#lv6}p@Lp((1pI{R3>=cT1g{$;LWe9<2PloQ3sEN?eoSU zV+e2ctYgzZg04FCtCMqz=Ypq-O-&432B!flhN}X8n-aZG##BRW{+0SGWV~1eYh_cy*+wz~?t!!Go;oV}2uYP<_m@d^oJicALX}ZgHO83UQ{zhay6Bce6 zmW9`ZDw)oX>3B3xQ+0EGP?p+2k3~I+b{gpCbUY7f=cSS1+b%fDpq;Mc3j`{VH(XP_ zuNFFP9gZ)d&?r~KlA%p{K}!|-d!mqU84rtHuc*1yO&p)E8&PLhHb{FD4tigII1XJjjuKj-`0fXw+yqa3q>JMGo8>Q)gaGv> zA|Nvb?(?JbaPW@6r&G#|Hfr>i)g@475-JR687pgI$G1m7%j}0!QmisL$NMtQs~?bh z&Pcz};*Dg1&;-YzMSsWD+`{;E_#B*)FU?@UDdTE@M%`jW_L$V-ne2fJS{(9xfsQ~X zLtG@P|EXj=Bhv_qY6xTTLc~G;!8$g!zmwqbduQ5<6Oq6cEF#Q}gMI{O=7d)-l7nBO zUK+xp2q6}*zXO_#RZP=efxX`|#WqY)EjVE(gaNUl+>Tgue&*6Ozff0oBbui*K*vNK zU0mhLcY~rW)!(Wxh_vK}v)=5Lqaz{zLeQf~EgJ83ji>fFSVa~eeSbzBfOD9Ys19P> z@Vk~_3{DAuSeQ)Yy;h=dLzKyti0&ytB;fWM?(}Q>A&x!%bvXqwV(P0CLkzz=;N%3} zj%c+)nNv8`iLX-ny+gm(Q|mE89Aopsz`)RHJcP%h-AwB47#o*=-nI2#vrMg;{fa2G z;NgSzxyPl=`7tiQWH`EOIqR&=1N{29VzmC+anGgCm`MsrZXA0FOuCPNG!0 z3t4%na-$8bFbFNpcH8&qGxk(RW*+K2PIZ3%OhN1%lv%>`ac6FEjw#WXxstmj?9Fb-C;{Je z!s)WZEr`i^gfDl;#`YB}3$$KGK8`b*H0d%c@?GsnLf9~IwaP2{lN1l-4duYPA&qsg zxcnt2kEAa_Xl{VioDT)G(E4Ye6}X$$f-Tx&1;TQbmKosLai*y{+vGk~od}8k6A=ak z;ogN1H(>U4pvgDP={VS_HKjYd^q7V-NY-U`Vp8K$J{-m)U6QL|BqVHT+ z7d;spzuvpwLdzE_C;8O^-zlBJGXfEDoPL(1*OF38-%?>$i{(7DKLLNe+z(2VU}scn zpTSeCxlD|~L#MUd7C-$+64fk|6s(&M#np6I2bCF;kTZx02hZmo;?dAz$BGAml>Q^j zZ|PULsY)9S$9f(C8&$lJkQl&E;SzfletX_z{Z_(`J#;|_sUzJ6-&ognYo6}<0fbnT z%Ly-|gSlCDbgz79;_ki4VXG z|DPKT{H8q!+Y%h+zcu*m&tjqaCG2qSbAao;BUX*cOwdWO#vqbs+DFA|JcB$usNWYt z!218CD@@R)f~6nWr<$wr`ctY_5mjeu%kY{fJe-Mz6I#}Z#x!kq?4EQJ@|)$6Zf~JQ zE5wolOCe7~eM?-RiRQ%YY3M^ve^|Wjv+7TQ$y99^m23}${*LTXoCO{)#^2_8)UQQ@ zUD?t`4yAxtYJYhBu{h*(%5}I`qVMi7BF?N}{wOj*>RJexxx7xC zub`2BhuBKnpDxqg;(=?mI>uPd{TF4Q(L@%t$t+A0#u&czNPeGbdx#Ay>w_f~zo*u* z85{Z?VhI$NYsKl>oHCY;IG>sQ1U!c)!CxYOvUe87)#Gl)ny7w)BfT zvLEz7&GIrXeeS6l8jvECUH*Ww*O)(|AeTR1haT7O?4m!;u(Akn5=u!)KlA^OGW-kn zOQrZ4K9tA&#u$JLeLwZ~gzoc4lK6G}`bA*51nUPRCTG&q%0xn8hZTT4P~C`gfmJTC zs>n2K-w5H>PUwp)F&4&H8A1q*VK0e~4oZg}akE>*MH+o)oa?!iox%?@>2clFvz0@r z)o-r6h-kWR7~sdu_bx={NIx)fmXFc>A)GmqHV07m%>cCy64)I92T%EaL~AONR?R@G zMv2k_JyWo7V~bd<ZA2h8F_nFwXRMi3LcPH1^2B2gtClql$a@ecHG237WgX zDrb>(7kN0wTdAXO|G3#0K;=0bN;mg1>kU`lCY@7yq&%0Mu z!SH}k&r2~Yw9d~;eT`S1PNMR4ID~D;QSbNMM_HEz`7aL{rpoy^a7K{|RuOfs^uM9G zpb0pjoR0l^@1WC{^-X-xgh_$JFHV|?+JFnF%_(b}ru}i;nO?R9KC%GjkH`6^UCD8U zS_YIeJ_tU&3P8kXEc7e462M}0Bn=>tz{p9Z;(Lwl9Fxxabhcy2(~f9?LwSKFt@W$^ z*XqMzP836V%di$CsD;`XttEPJ-~cGj+-`RS+j^+Sr(>_xv0D`U64dM1_y8uiW||ja z_|1AvOo8km-VqF#m8$7|md)#_gHCJ|4Ym~prmz1fJDkk_E z^)w+EkwxOO0_9&lq}x{4>g^6l<9QO068nm^1B=S;bm&TEa{v@(}V`6q%{IH=gxE2Z0xr)rOP?H7F zX*CWU8^Xcv(fp5I_Xf)ytf2|~Wo~s1tb(8al2%yH=?L(8_OtTh9XL>=-iF6F!>DUW zjc^;$ncfa*(R|z9xvJJVx6V=k@xK-u&{Hpa<=?W@%2|F_>{HT2`bU1IBvcBmuE|N)RB+xX&=vobYSo2zmhTD%E`uQ`mP{NX zyqNWPTPGLb#invS5&;BEcebi&5?hr)LC=T@k(HEh+>WogvLgE(Fxu|7w=Sf&`&}Iv z4U)eL0gNa>z}lPbg+_t*O{`GC9Nqa_>lq=nqod;sQ8b2{cQ^#Cq6y-l4w`Qh0Iw_` zHWLR=4_(mQm$Tv&?nEe8Wu5|ff9Wc+%lFqs&Mxu@BtQTfRRUPY)aYXTnLlpfFWc={ zQ=T)1H=+hjUsZjj0CY2dzwjzIDDf0N`~%|nLmm5XIQ1{7o?^=Huk`OO_lP8tm=#UJ zaYQ^}fhZiXbzOHBuOk+)@eybaBw*Qp{E&J6esPfOdOP4B{T5H^zOWlW#dy<-ncl+M zc(5{=Q>`Au0@U#JJQWdNXTe^6@mWFhk$@p60z$UCFUonJh&VNi-jZo|_c#=L7mG1sD>M5mS|N*OuM0#PFeIhOdfoq41y-A2jP838F`%Qjyd|1R)X}m5`V=v z;6J02q4A5ag<6$qXx4#Qrbcf?@20C1RiqvRRAGbB-#=q@f9$xy2(^wywL1N+gaa%^ zG0{}G#OpQbq9>mBS8q;t6|y3x_-aGyHmcFA%GbhY7D4O?NhlkR1Ca=-pUZSA(mx4% z=KzAvy*cvfcmKqR{(p-ItYw6^5NkXAs(Kw`!l(W(L<~ZGuzh#enR(88w&?zFjD8Y8 z?t`vE4iSEna&@#&Z}=;C-*MAO5c`wNs)9->j`XX~J6~;GNgr2^vP-s{# zI=sGjBMJlDm3BT6CAFo9Tt&5r9G-}lAL|8QOHf0ODp#U8$KZ2)P6B#1ULH)G8Zen6 zF0wO{YCxZIV>9w;LK8?J$>IUM!Ie9vu`l&+WCZrqIBcnby|wsRrnGEBHW$C)u1>+I zx5?s=fQTB_8dc-*oQoTt4KZIf-CHe`J`09UE)b$J6%GRL=aB@P*j8Xz!#gL)_%A~j z0jp#B3Eft4{k)n0%7KUEk+0$^U*N9$(kZJ;CGq&r4(0z+n*E<|8dDKLhOfJ1e?P4e z|D+2^P#Hd`a?tb686HR-RqLKnvNYR%0A54S4}I!lZruxpz?XM>>;{jC^8s_}6J&_# z+!qb`xwxJ1M3Tem`JdY^{)^VVwdl-N`itrtfJe3lqStLvm7qqs?bn~h3+)FK539DI zN6IeH8<+ukrUIGLl=GjBe>!d9GTn->4n4!SZ+Xbw!<-y@btzBJeZR6te(lJX{t*Wl z+4q<)fl`PmRSlqCNp;yVUL%_eu@Br|H0GTnT)Q{TUizPX-kf`9s` z|GCD0{YEMUrN27TKY?`qoZf2ZeUim-@x)K$P5PdmcoBu@UA%RCGlb#~*kI}RG{%^v zG}l>EO$%jH*Gu)Kt>#u{2W_PqOBTOsr>IvE;DW#7%<{$D(|vh^!Uyx3ufbQH=-nxZ z=`>}C>pAh6>#UtP1IeVveWu-`|)iQwhce@US+C9X!6(hcTX<19bXE7kw3;!z(gFD{@!DciT4DpjTsnk$^;;+S}u@N zsmnil=?OpiDLz4uyk7g(6}Y5%BO#-j~q2)&XscO!OONjLWOanW7hW- zD(}nXCg;`>LPm(+rMZZgb#SP40k_8!Z_6=LGX@0{o&*yHjKm=!28KJKsLr^k!GzD;LiQYe z#)ilrpxFy`QcQ?gbKkhrGG;*c?-TtbX)a5x5PKNSANBl-5nTtPGjfsVY4e1+<;q8zx^AfWRv%sb~?Pad%RdklfRwD=pDWcBqBlqMjd^~bV#kY80yS^2o1_hdAi`x z@@(Knf*?zdo2|8&5JJwMMsSMu$`qH9VDTyzdh)Bwd_zOWRkf zJC$ekTq6CDk7VBn0-tG1&33|K*ola>4+|2U_+Gg>)9Kx#I-Ryv?M0e z3+oFblifbVDYb2&NJKLc=4F+{ODK7GZNGtinRfO5Wk!_F7gK5poa$3bFFle)FK=V& z5qPl6BMRj}k`M`3)nNkTJ^OllH!6tSYtZEP=+k7mRMC=vuh0`NSE62kACvef%bivM z`{vEs;ccFj$1~LD7}_3i<(5x;p;5Q19UawayKlYZ8B#9&QAIlojIS!3JLUtSa*IF| zPscI9*o~41(RhyBGDqp3hc#M0=kdP_=ik9AtFL-Mka)Q!{V#j*FRsb0QO;E(*lx)x z%SVWYGS@WO3QTu&l1ZGuoNrj0FOfX&OHdPV=K`(47+Pli_1UEuQP_@ZVvToUYxs7j zIsTI-n}>?#(sjDlyLsj)B2s`MDgq4fIsk@r_8vST2YC5}esvzwtY1QmJVdL#K_uex zf5v-MwY{v0cAJqA=c8CZ9i7Etc#U6{Vl>}$PqgoG65f?m^G&41Y@N+?h5py^haU?3 zxzAIbdf_5cqfZ753AdFw{m7UfmiYR0-3b@sTQ+YAsZ1u)GV2s6?agQ2dP|#mpHu;+ zM5OXiApAMI{6M0*MY3^UG(2`}L9FT!9JbP~t;P@Ho^`<4VBcXyd^xUs?+I{cE;`Kr z)2OeELS$t&uoK|d3|g&{vstI>_QgHI+cwyH61Qz?Y9GaMP^%+Nk)}l=hob@}{3o!P zH)oS4*WE*nR%kR_h#Wtn_ad>zhnCXiex<-j-VmcYlx%okdM2wZWa}aMA#K6&69Ri% zglbypdG51VzP;^qYI*^}j{Y3mMkryYeOdjL8x%nwW_9dP zwdW$cw9>idbkcV}T0>N3kS|=Px=dEPVVX{GNEW$+r=~t%-Y)a)o7sc~1zlSNpk7f} z)9#?gb5VZqLp3;-cOh#%1HlH@$-Ww?l6^hs*ytyemdx~iEzLp#1wLpIztLyi5Oo6tRZrUvnHy1r5C4+)bj zA$bx(&tFmmo38SnGv?)TUrVTvaLrpXOSBPt2gmbRfhZ(A;^M3*b2c{!-JaNUOq`+M z78WFOi!g%9Xb`z71J_NZ8um%J-|t1=PsKar%;+Q6)+i9}%g1gc_Dl7IT#m%&5?%w> zT_PMf%X#1-kCPi!Oai60yA%8C&DZ;;0_*#{?jMG`s>1jE>NnaQdI`tswIs`w8H<+zGZWZs{1XYPinhbw(u6TdPVep+W%X(+{u?zY3 zvCOV?hI1m|#U)Ci{tLVN-y=T15CJyKTRh2pxR#dd`0-SLqgK!F@em|Xn}bX6_~Ek^ z_KJRb?nMuKlO7PAu@@iOn&&eQBs}8L-Rslg*JkP2=2V{P1*k^iy1l81g*BS2H5?9X zb00afg}sL+&6p723?O(I=6$QNpkl@{W=R8)F9|oIS8#@wT4f;}`J(1^S3Huu#PoiC#B; z@xNdl=uBlrYVo{~99U`%_ebi_KxWl%D065fMDuF;j%YMeZ}rE5%>Rp<4fxf+Ul70` zMtJ>keKWwaC$w79Y#q^@qn#i2se3&@%Sgn!IF3Q)PjrZAG4@I{Ry=pDOjP2lq`@f5 zx;gBzsD&+P_p@eZaf#XsAwsrU^b#}~iIS5!3ZLTP#$Him81U@~rv#_SMcrHc6@+Fq zlZRzrA1#jL5l=i@dOnGjQB}a_2@G4yT64aoqU8EEST!A`WG`yejL*O=420Hfz&nPCbgBH z>dX=FIoxB&4a4$)_{vZnnZJcZXRl9vv9M0U3Fmg|`Qu}PRgQU&8Rus))16PZGdb3h6BoaRi+kTduZOxR{-K zj}4ia|0#0$?;F$+3yicr8>qCrR0{s)%oTU>?nvwUhlf-O4!g?(uk1n0*Le5vD`Wx( zefqTDa|Kv9XHw-_=k8@wui37c#X=k}2cIv)?Ok~4xJ$#+4TT_SX*tY=aB-Pz-y`g& z6IdUROgM<{f7$2_&G0*+Z#OSgHh6j+ZA^l$>a0H&m`-M;zAZndncSziSJ=;NI2rMs z{DfY`B%l6y-e&>=B%qqPGy5Kyz~Jc$o#2+BGpG}DuQls2mg4=fsxjr-7`9EsN!(Ts zzvBGXc_*IT1p*xx0k4eU34<2?r>e5V4s`lcR-@j<-a{*-XArmz+_tI2v1O$o@ z+~Hhnu|uj%*%|#+MpKi&X8rglu!K})PODhFF@pn-Qd4`FGEQ=g=&)LM^KTkSfwGm) z+t=4o3XU9R_{0jwUpFhXWw>%J3R>lq*Xw9;_MI5nFLXq4SUyimZ@W(?Nz}MmWnL}5 zeMyiCoiIRn!}&k_R-6#8i zNC_7tvF57gk5)l@oic>Y%glp#Zs?t<^_LcX1;w8X`H#RYw;v9gtC!$0L66BjUt#g^ zIlxo-;vr>vC;1>&5OXi3x(49?%jvz;fkCN%Td4o^0}(T@&Y9Ss6EW6c!$G@Yl58pS z9D3Jw@o2C2!@XQa2y6kxZcrwbvgpAQoaYyG0Z#R!+ttHUA>-dS%@F(LVA#kWjv6a5 zpz%4cYwlv0&W^OSDEnUhe9_x?%>Ll;WY*$GKdY+XR$crD^aCKsh-rQLp?@*z5lux- zK0nk>g;sOgXOgs0x?2d^*(E~>Htt4dqX1lgkf?93SZtTGHC<#4Obc?pR9QI zlr@q__f7eQ`&-*NVRz@cDpC)f+yP@26NOG7~26%T611h6$TU-f+CLF+F%4 z-lBX$8SdG+QMPn%+_jy`T%hIpB}ot8L~`2>2#h5>E>+lD48Z|B8eg{F+7>treA!1K zN!>3z7j@l8MQ3*YVl`ia^xk5#PXwizEl1sXJfb&;_VFj#eO)6~ zjjNr;pdxe42;|UmvrfWpCx$H_(h@b{ZXWZ_`Y_2@Y2lMUWEse=31X~)|1E>EaD}tw zY6ucGlbmDBmZA>Dn_qEqJs&EIIqgFhh-TWk0STqA8jXx^4>eQBird3^%=7TXK4YUZ zcr0JwDV^h3SqS|8?P!4tql6b@HGN8q&Ajga({+hCzsyl|m4xLkDB>4A3b4{Y4;|E~ zthA6rvDpKmucYGli`zy#j;M+_q6j~R`#ZOvFW;lbs>l!+9NZ(dXElIYx8C0ui@)mJ zQ1E=!!1eFk(HCK0xA;j+IS@M03F;qrlmg|x5A=*}haL4r@dq=9mhKs&Klt{3Aj_>; z1fEHj@+~Ss@6a705T96Ut|w6+P^#f&R(5r~YXcMMk_g@EX=aCMzQ@k>$+@2z`Dk#5 zL|L}*g@$?)3Y3C)FDBP3#yX%`pIUb^P%SV3fO4}}BqN{o=S_l0`#ZOFX!y2*qPH$b zJ)DwUnEiglpUzI9Xk2j+0ukZFoFU^SV1w<8T7HbnMblwB3rl}Hpfh2ci3)IdGm??Y zC3zR5-PC3f-)5h)1NO}T!i^3Qx9qe)07lZLQEypqJC1>DAUpk(lq3y{faWhYF?0nbgV;2vnt#{^&Iho zk#w&Ncy5PH;jaQnW~j+QisX9jKmC? zsj50GYq1&d-iit-9=U*#_BK*bukB1$=)EmRTEOao+DLF9rJy|Te1VPAok}o&KGm@gjgU|p@LF+sTy52Y8HL& za@8OuG0tFJctKbhZpj5Hl;IUb~Q?uG#V@{vm_HZ%YTvZ%^ zQkAJ(@+Udz%5yY!TnH-1%d{+ShuEL<JraeKByS zbjx~TE`JqWVP@_!_EwClNdT^CFlrRDtvQ9>NneI{E^UXj{T6g9AUoYY7tf(dIwQDn z3Ty^^II61me@w*wEAde0esRkL_kvDa*1kf#Dqlk+@w`8d7fAf_rQj_T2vL$OFiPs3 zn7#%#$ue<{ux?jjh^5*|fZS)5rlTe&Xt}oA?!`u&sJo}}Sa&$3ZlG(A zSiJ{ms7=Q1X(WQD4jmRu?#sA1_jQ5j*MzW)%ZS5QCPLVdmaC_`yJ;I)5PXmolzv)} zU3`AW!+Y$;tgoG3al)Bmw2eliH}6OysltFOw7OWwlx}IR^-XA|jckfOQE^Z&-|Dt7 zHR%CBfaH>=ZSunD-?%-eTEJm)iz&QyN~Fff8-TMLssz56OskEdtzDQk(MT{|exP=9 zH4np^SyuDP!YkKTsFi-R-s~R4HK5s^>MviK5r;0Y&C-cXz%SBlSP|j}757_NPoTzQ zx2+!y74?WiL)tkoPGz07ygriue&T*mNlsvEF9M>{ECL4UlC^J+yG{7u#?eVqHo-@hNOk4%A-;wGCGDRA>81){?L}9;NJZ36OY) z6LO}=MsX%nmS!#kOjTrpT_QmksDb&;FO#1~VRz zE+O=uClT(+`U%nP2~eZ?MG3TQ)@PNtI0mco-T=LTe@1LzvvJA;AAwoeIEWa(-s>Zj zL+0M*9Uk$W;^Lu4_U^`UJ%h_%S@p)FLEYP2nD(jwjji5x*l>KWq_I@eW7r|SDF_HD zsa;UdKFQm6h_zbk?Ux&T$XCzFU60x0&1kTM>`L>bWEU5T-1Oe!jsr9C(1%4ydKx}j zWjB_|IS(b?Q%=RiCfHe!Kl}1%*3aY!vr@=^{njb$CnPB~Y*J)!;l^9jSD39N`Yi1h zHd^jmai+!$S*P7VCz`4rx`qT^hF|=^twr8F{ICoGdyWB=HVw{-*O6nFv z25osVD5;v^pUIBIhNrHOmS6nZxBUatn|zm}`WtB)bEga*SYjoArZR|s<;;nsy#V8O zFml{d*7m|a-(E;wT zWPSOFje|pI>bc8J#Lqi>@L_f?tI-GE%n-7k`gnbnNMz2@Qa$LgWtVWa=0;L<9qz+T zwaKi!#TqdjFi|bxC%>Z7%c78y$^sQ8wYtc_ki1NV_h;nFHD8SGtp`9bv5P#)o7L7m z%@_;2Mkg^Lm-iGSG>i8!M%xs7CbuEI=!~OOqy!rE9q9OzR9vPitWR+iRA#;X5s~jx zH{Oa(q=M&B<<%S~7e5IFF0>y)*&SYa?pj4NJBoJ5Vwy6@(!&|UmCFCdpRdnlkiaJ_ zQtNOr+PCJ}dx(Q(w$w#G_c*_&vtFkxFUS!%DX$sN?VWgJvb0NsEiTD*(Hv~txf}hp zF5Bcb;LOov$%C)<9EN=$T?`-GsuM>?ku(qjmFPriq6EGOiKAJukDP5J^h$PFngV-X z)m~L9{T?j(aKC$)2s=^3a}sKgcrj zlAf1G3OyVmQ^<`}RUbo*-4>jTyW_@z-4!6cj4~VcE9u-}SU%w*eS&@|LCWorak&Pi zEN1dVt*M15%~LJ2!|p+daTQm-sVV1X8&>B{fe;$o5O$Ib`gt#K-U`3NF=L9mQ*W-j z9ZGD~bx=>NpC5v7=_-+Y4d2@QgjH*{Ft2*RD!cUyZ>IiIUYue+_T!w~D%}fATvCt@ zz_aI?rY`Dj6L+}o>>pP4o%}v%DyCCs0{EVf{PS@#Dlx2T-cJe9+@EhfQL`{5wM<^( z2xc2~q<^)!Wgagde>8F)UjE7t6RvqKyr7xgrHdkJdlse2_b$AdQ#=nfC)GEnJv!h~tXKhCn8?Q8O zFLtxgD5Nm)kW>g_#x}#y98E$!dI7H_--k%hTrrq0mkL=hR55T>8mnsx8qs zr$AbK!x{p{JKL-3OhwcTcJY2$;9_%G}`%m>$5wH2)oQ{&TVeN2l~M{+mVso zRE1`$KamJtAVME2L^4RnHDgWZFu`*;N}<#c+2;Ne7&G7JN8fCn9OH{OD6J;jNcO+Z zV-Zr63ne2U*I(poq(G%~0`rWZ&1RON@3&|sKZMCEw?`uobGbg&<*NOls_PM0bwwq> z#nc#r{#U#IC4(4-s8f$$x<#@F2FL+yg?k`JWXxrgh*!zP>|0IZ*a=IBIyFg=30T`t zUjda8>^cKoCk{DP<1n#_lkAo%#n-xla6Hjc&mUzwYdhbElS*>NMAC=Z#awT1`B zPYZZ$3gYcm-q#S$j%V-Xz($EGlH%{o7f8MNSiV!9EBe{5*s;%+LI^zu#^VZkr-l4P zJ>FdtF8qY{E@J%rX<@4NM9%@4P=mr9@khT7M^g^`FL1rH6Ah;ZhfwRnN3e*goCZY@ zdwTs7v^^HP56_|#@wv%I#)`Ji5AASxD$|W7#L6MF8C!TF>VqN9gY4Rh4^Cck9F5t^n-;b+oVas_da$;&EgE<&shvLtk+=f)T7G=-WFx;FDJ<=gd`c zS8i{Aq_(XN6fT%-v-V10Re3m9TF4OG&dYP!A@7=VR-CX|#vN2$OMWhEMj5b80=I+e zz<|DL2BmTG?ZV*vZnWh)>y1SSJYFRXD%^YW^N&KJ4xWQ8KnCA>Q);p#NqAs{oEq^h zU&u501@n=scM@%S-zt+YW7MxaE{a4Lr9*N*&|E@Yqt@|#MOOLEP!!)M09K}QK;={q#L5?-pyTR6 zOyVm>bg21Y6NI%+<|sg7IN%W&5tWuC-dgfZH=-&AY6Sc)_%4m@hsM*2Cwk=RtmlZC zyn}Uo<7MQeo5}c3hU5*_<=a5XSfvQLp|dCgb_3giOTt^xa1tDeK#h|mLM=+!*P~+2 zn>L#`s-qirN_rDA1Nw+pp|0eQE?(oJ8fnkV<>IkS5ScK)SW^Ine#t2T#v|9A`a+5M z&^)PvAB0km#~i&ub>lZ>mE$+IO_ygI{u7{f9{yn|j0AGYHAaSeZtD9Q`Xk3?VyDr# zq}TQUjgG8Tl4a~vd?&;YsI3n8u-j{oNlDBwo%P#q%y{ikaVaXzB$(|v4Zv%o*Wm4O z(i8iDDX8h0vJ?jn1xBFhad*t)ebU|y;|0Pt&tw4}58MwH;W z;-r~&rX9x(V=F|l&0Op^*GLoy)nae-r2fl@&9COc!n{0|-Mev*o7n@8g+yzLmzwKw z5*sLNv;U~(bk+={PEE&Y;dOD_A{>l&=Ctypn`H1VJks*7U_Ht>^ITjg&DkeuD(xNC zv9P)qbs(-q8UAQS8v32a8kk?mqO|<9p!YghUVX$QTMZJp^|RkUGNS!E)Vad|-~*mj zX}7YxMIhs<`m!O8KN#7dtZZ%BgpdxWL5nkV+3l@I=;Z!I(9*g|-?H+^C;Mk3Y*aqtw$ z@#++Nwd@iOTW-&!5=W0a+}ooi3=)hEp0VKm%2q(Te5Kcem92B4`LuaK?GuCf>fEOl#43>Z+EH`DU=85 zn#`pm9P5Fl7O1Ln$HyLmP17@LaMn4!H4Howl_DnFu1d`r*|g{G1I<4(Q)@kf+6}1s zQ~4z;+g4!8!4?KKS#&-lY3y_A_10t6^xj;5A@!c0TA4Ij;c3B6m#)G=jf{NN9fKi<#V5^vFNI$3U>NZ_x3{F=g@`XTLkUf~7yvIS=Lm)Isc1GVu?sX0jht>TP^j&7G33M|8m|@<05@B}HmvOS_}UK5 zA~)Mn(Bu-8pt!Uk>V!ef0`6*vdnEXHw#)(-$3)~b(h^`vSeR&f=4&Rl$H<0xeG5`> zY2!Z-8 z$)24vwHcO;N_S?*g?FL{*NEr*GAR@g!=hCr3rpG)bs2OxvhtdbLuOw(h&NgkyoGDG z8gJn!|5YWn;O#W(U)reXTTYF`NZOSHa;%H~1V;q~M&xwNLZAbH6hO8e8bywL()uPP zN9X@>_Euq0wr|__t=@>DB9elH64IcO!w@PUNOz}%3=Koapdd;~cXxO9DBS}LF!azc z3|&L>UjCo^dAH|VdER^bR#1n?1QW3`pC<64>wE#J?PJVTFoy}-d(z8P zpKKNFfc~+I>bT;rCxTXeG6V5(iJ9uM?;?dXQYjyNO}I0ISG>Q2Oyh&zQy<=qs79e; zJ*KMmdPd|fjz2z<-p7*C#(C|%X4*aXbIKyWPlK8K)op{B`{cH(GJ;m0#o_SK#ls>EG6^Zc7d}{0SF|gEFAkl>R?B3Gs-`s- z1GVZqwR5sNd@z_Z!8eEg!1)yn{{hI7BSFPAYWk`sis%G_8F#V8Xb_)k(!_pk{LM)u z2bII+qaY#OxS_`X>hR-+t^t*y5W^SKY9SeC9Uxz(7|36krkag*Nlk)DG5q{%mI(Lb zbsJD4uZ0yX@cx|;WPkkUknz}hHW%{@I5j@CkCW4C-;HAVN)7b%7*~-gXyTCk_*MSt zp7Mp)j}sdVu#)twjbRA{fT1IQg&!qqO<;(XJG14u_X<-l^Pd?jnO~dVI8TzaY(tB9 z(cwKeJJZ(ZvK}HQp%*E&onF6X8ia;qS`wx4{C`*^Fl|Uziz0`W1skv=LYIMH&Wbp- z?gKr&>!xTYA@oR7=?3ZIre%w4WMooj$&ksjNnB)0C!$hyn1P*E0)$MGbRQr$ecG3;6mumof~Jd_^pe`7+gtHLXEXH3N1|9$>Z~? zk?HXMOu2;W)NrBBul1z0xdx9Lk&qQ_54{EtlFp9my^uuq8&g4SLICD5nOr&1MXMfIjksSBpV7Ny%gV7 zw4%mGGwwxmJfQ`{MuU3Xzy2gAY)SozroLQxiyg5$2o^*%X2HNF{g`q7~qzsYFaNG7UeLssOw ziSV=)XNxt}M4bgI`;Gz>pDF0S6sFzNpN~H^OB8ih8Mf#!4=2KFA(Xs3fe6xe;GMA- z;M{_m&VCJRCbe~~Zfg58i5M@`Q~$dg=4}V?{fCgP^KGJny$$Ami`S!NDKA-{TuW?@ zu1mU+-d8sKk!1@gzT-^aBx*vk=Amm-;w??4Op+;+vR8evn2haZp21~^)rIHwJ^hgp z&Mn?am@=*88!GKqXckU1yiua%uE0dP^<_ez_Ws{y64)az)FRA<0?jXBb-bhX=RYim0Sl1hw_bvBP}p~`pXTzr#m{hq~=({ z1Vg#JhaP6v{ugN?(8@W!-SO^%6SV@$-1PxNrT$RJnxNKiMMC6zW;8>vLS@C?sXr@j z`h7V$m*hZ9Pu?B&SY5p+7@Kp~0GLP3wC=OSB@XKn~svqq5UqECsKOhf9> zi%%*VNYzgZX#1$84hE|Cv<#FXhJHvQwAeB~Pp;k3VZh#1?7%^`(D_gS666UW_cr-GI zQa=7#VlMbGs|4QPMAC(Pl;En0HV~1UIVW#!6)RD_JJpV{h#zt$+w!=4v^cgn)YBPJ zylZ5#JiGd5hB>hB%>S2*zDH8PVz9lUc}>caWl=ep!vGW4VgyN$t{YM5UuR!yps)Lw zsLW~d@dzB6TI1a-8?90!|JWw9zw0u9v27OEK9c0IwS1N_e|yA{itWwR)9h2G&92qv zW%4Lm8D5-cHjs@>@Jd&B2u0EV|k1!;)G$wa7@r$8X)Q$7S_z9YRxn z*+v|4&)KW&S&7pUFy{yd{{!S=7P&4e$U9Btu{A@GQe;Vh$MIbAw=BQU#1?=rDf*wi zJZ^;-36i^>oD4mgdJT{bXbtc}gXdXcC^9ve4Cgxow$Ui7ol zkRr65wz%+X?z2){i`Z)@p+-1p|DyS78O8e2H3G5|o!bzJuKT0(?9!n8Wo$}NZuuv| z=7LGEJjTKtgC8wx1CLm>HqqbhOUqDl<#yo)hl@e+iv#UtgQ@P&joAbls8048Ly=)F zi7vMU*;*9!Dz8IFOYMLy6{;$I3e0e{2?cK2WSJCHxHZQ)q1#GlI6`gO#Ag+lW||KM z93=nc^wR@0G9e)-=Q*KhKqAf$OwY_1)0}_e(9KE$>Yh-M&2D1|t8rPhE0`Op88X&i zO*K5@wxmQ)l+KvtRL>jr8WU5FOzr)F3HDF(QV&dosz4Psy_9T;M6=6vFp-U@#mz@$%suoKP`OfV-A2_`zQqUzILR=j@5Z_ z1_o)OYjy+-Tkf6;rEQD819aTcfQ+jG!!)%fE5SE~Xucy)#_j6i4#bZAi5JKwSiSCg z84mb7J}*UKy2@^bY?%uRespbT0X&F2dNShiaH030x4%^2P9Xy};T9Kp^+vBUbKWfO zd5oRmR$@`{INmN-UI+=DlC^q@7m!~n`}I6=$ON_vY>@S>c=Z5B+ptsLFOQ#~EHR<7 zU3K#jkSNy>EDegjV&Y?;w@!5T&N@z9?Se&Uwfz0jmK&Sae>`{O5%s#}2+O2{wK@l6 zxFPpqJT(J~egfjHb@1U%AgPJunX@g7zNJcDJjSXoRO#AEF>x{T)29L)1NTgK-ho)w zQVzx6CZ#OFI}*$nqSA)Ryc5-BieJ^u06XIL||!yP|7;QguoE|{-k?pzs%K{V>v=w7|3ne}+r;gC}A_DdNF zXb68Nj~+Y}Sh(ja^$EYx^bJOfE+Y`Nn6ZU-LezX$H}7HgWcFA9Loi0#Uid@T9e73e zIAW0fAa_<=(3A7)J`Zd;C2T{@-9N>$1(@eO@$l? zKlEcF+I|xuyIRTH4clzHNv@M?&;D}d!RuYTu zg(bH(^{?N^b0Q{k*39phvlQ75exMhYAsvS>fVGrQVyBTpjz>>Z#C+z1Hm4&J`GO-0 z8c#TUKxXD;EUxEMkFVF#+I5PA^AtYP6szq`)a@$XNUK4o^>i8Et2$Jq`6}U<&R0REzmq&6zftJNuxqW^lrm(zf4=m2lVJTSuex8i+s#vh@ zSEr_|$gCWVnb28jd(w?g&#(G?MC4RzB1Uz+0LL4{FB<-&3`_)0ua4g}&PB!xjy}y> z7TsT4E`5>wK6-$avoS!392ICz{~(a4;|VbZx9)Zj`3BXPgZ-L?C>h6PYr($EvWHQ> zlv=}DSnf|Qw_a17;s{ad0*<I=vtV=m zVrg3rWB(=y2uYa`)}4>g!8O&=7NJnrpYDgTvrOyUsVdHgR?_^_&Jq^LcMXmmPcRQS zl=~Lrxrf!4z+PU?Mt+z7gTR@6FZ?giTk^|Z4`TZzdz*=z9B(f;8I;bcUff7@9D%=Z z=B+o~Pm8sBtiWR;^X~ji(ly5A{A%@HSS^4%>~ei9oeKx&BkO;Z@EuYf&uUXV3hQ3P zz0_g^H^ib+SKIisv8B?62%J@FvC<2%2-|gV7i~K4n7NfcneNTS1)0bSY zL8m|Bk`Qx*dZX|va8A|*3wQ(fJsFb7xl(SgUZ*5&Opc~~R1LDElxkTY;ORENE92W9 zAJWdtDsVKNUrmzzDZFXjzv_#J&f&>%E*Lqs^SAY3?e3(5zs+;JvHec;Rg>+&z&qJe zF{bZDujeqpMivBDr>n+c)pjF_6$fM2+bT_V6U6SzF8y@cu|Sst9XUUTV#wWpH~$as z{rO%PY30(<#U&hc^fFV!`&+j!o}%t(AM7whizB2+#5lA@t8!ijl46xp8*Ak#9{Q=y z8|l%wcsi4tR%KsncKhe4x&Ggvbx>JloR-sbW8R;w7s{42be~-pEuuWpm+)vMRpvbq zgEbi`ZKhc)(c}-8MirO-E9q*P*07(tQ2mkHEo+R<8JUS>rdN+srrckQ(%_7hOPgOw zHO_Rm>|O=&vxZ_-fCHG5A5w%uh9=BSAxst$}oWo@A!z8q4awAYz_xZe-cw@sAvB){%)Dgm@A z0pTNE#l;H5K$`XwLXtpa4jmX4xsx)CVCp}()KEuTgsn0G2US1D^{0T~-cI7OzMBXsfiuHE~SFd7CuX}mJf4+c}&>C>-d{Vb)0lYHik_|4x1mr4vgb#5QY zNR^Z^v@I{(YAMiN{UB6(O@r)^E#ze`d7sKu6}zo(Rp{i|aw6Xzj3;IeyGkC-QrO*& z<~&P1LEL<1XZxJfV9L^T=Fu$B;m?oHLn zIG^NU_s4GCV-mJ}*FkAqZX5j|N8jg+Fhx{{!h3{u9aHPbp*(+?&HRKG|5!E;P{~Ge z#Y7Ya74)Uw^_c{a63fYr+%}vsMq*ZSCEwr?zf)q9$actG(vPhP4c(r5%G;Ne_KUH>6@Vp@;XV&J! z=b^FTfhIfX&u!Q8&pYi-rHy^b3Q1RBc1OJw#(aON&@qilNFW4(H~2nSf2a%JV=zOP zS>912p)z~5^*;u}`ta$gWHmfawF2atl9UxMGZ(oar@FM>BwF$@r~=0;jNtB>Jc+v{`D%B0-19?Cd8VU*4YEOVNb8KC1%RNC=%}%sbWu z!x}SoO^;QIT>;ev7Vos01PGny{jf;3Y4(_M$_}=z1c4tzDFq~pg4-7>;FrVm^6Ul2 zLnt{_zz1WiC0jCaJu$|kdToobOEAdF^~?H2KVSJc_B?1PG`CfZlZ*g^T z2s-Vn%9yT8ajt3I(R%!XtMEOBP8qn8C;0*nkY&b;QOON!4SV-#7LVQJ-tav;v7fBW zv)T*B*ZDGz&111j#mjSWLMu}}H}9ox+XfNxr50ez?7KQ3zj`)K zJ8S;k=;L=hh4oxiAo<@ZHjis!y9P1!+tE7Ho_1Q6?;6EOj)}MZ?B798gaR#^y z#(^)l+KTT*Cp4)dv~PAcOJfatL7%^y$s?{u7O-HPNc<$XHgSzp^?I4TG$&Bdf7WS4mH+MEEjzKk` z$ZZD-io$A+rSW0*V=NGUFb3=6W?^c8zKyGS;DeRX+$Qzc@|vzRd-jOidu|-T`deLh z)cj<+M5Fo_>>cth7@y_(6i+DT!c{dVD-rS{aur%QUBlfFu$(4V;f z%WkE53L6k(KpzjG&Q514K3%yL?QBjeDOH!Q?W*{2qhM8Ry^7FcD}OJt{nGU1RdMsT zZt;>ID)NXKix|}40Q{OAk5>df$Bx~9Z`T$aTrEoUKTo)mahQ7P8Q&m$V zRVTHDO6rjU80{oyk;j+%+S!qrgJ@{A;!veX zmd~&OpVW`egB#DtC0#&dU}b;@00ltjhKMty0y7PUqv zNLit59-hWxSbhwBZJww;Z07RxW^mN;{z^zADnr5}rJ9#5G3T$abN-FcM}-+txs~X( zj=Z(aRrCG^R`bje-@8qlc2?tv%_No@e8~FW9%cFD+ivzZPP&^^Q(HWi8kPOC@73gr*^i+t zBjOJPgo*Mh=c5Gua|erM@vOOw$oQL&Z}cK_q9A~!*U4gCC+=wc&Ffch;-Ss>qF-)@%HCWV!9bja1y`vYKb% z*cdp=Jy9miH;#HOZb(B`2^d5R6ih5o4Xw3%bq-csA7wm3Pc+N-ASh~gAx@!erLv~$ zDGBgO04zAJ zm_RP$TGyUs@J@CdxlUnm`VSTi5DGrr&8 zL%8*9zI%n~(t@&|du|hebyb4N2U#&4Izj9PHcu@v1IhNJ^iODa>njAd<8kqr!8YSv zDTCUuE5;Vpvoz)X(RFz`a@wZ3GyQ4s?i1B+yfSHb4&lmhz~|bSa&ojro;I2w-jGWd zrtVy>@Woo})7|6d)mzYc?P16JX;$QOLA9M|g+P(J!>11IDTDH$&%MEV(!+ypbz&CvdqQf4VBI_djr6xsECGyVE-x`Pn8>={HVesckcm2_Av2ts4In% zv;5B#m&?6T!*hbTQA31sKUkgVEc#+ob#!(f8}QjtMb_Y>2HVEU0LW2jtA+eE!g)*T z*~SMd;dFsVl#|Rx)SSXOayPd+ogYLm3szz>!VI&k_+m6RG2F_BI|7aLIS0QIe+cuW zoF|kiYgea)mXyi1%x3N~_K8l6lSd$u3u=*e{ie=p>ILg9(!YVmp3h8*<)(&tkcc{? z1{va0XJ)F9p?~r9!ri?$;b6#uHMXHeGt4YUFt2OqFNPzx?H|7DMjG5-hEKd zj|k<+!o7063n#)cIQZF8tp)Q{0!{h=wfXXxQftm zbjnERYRG@uxHuyABy4w9!i}1$Dme2o%v_9V7g^sl=0M&nl^@hV1+)t5fl=buAFd9$H}p0^FP!2jP3D8m!lJOwHWB1*abhX(JzW#`HR z{5!w8J89J6_eIu-aXEjf7r_3z?aSZOReMtAq#up@$zYMGyo98xQrB(JihZ}t>a@Dce z#_Ae{Tn=IWe%%kO>N5j5E7x+8A_Tzv3~}KQ-n_ti9co&%?=!M*I}tbwx1fS(alQ%n z(coZ-$`q@)gmaP8o0V5vR};x|F3}&9vYN3H624G&GX#(oi)<>_=E88uXuy#BxwZOB;Pj7m+PuFT4%kqzE0p0}g(+5QbV zF$lJ#7vA*P@$|wHqnw-O&unxWb7qMZib|X?|Ix0YoLuEcJq770BP==Z0KR!70$EYb zVa1sPL?5tUI9^DjJ^|Mj@Y2KngwLfW*w>nlUBm+zci%`>-8gl6j#z1-8$!OoHuzwTs~-| z@s3fs%pzQ9^&~g0Rc5d-G-+qf{4zwx6=OpOy%{~$I6_?>yHFj{RMZU@Pd)xy0!g~) zAYI2|*>LRJF?8pjHD*GE^Vh7KgO^s*?gsRhmBIsdny=sd|Z+J_By zk8wkaA9(LbX$@N?=gb3&?gA)?{1o)lyhX{>0^I$+ z!GQ!o1MAZso8$jG3C9R87Hntp*R9)fZ@)>!b~$~kQmVXzi<7qDh+$N@4>V0QnlrkB z#83OdBN~<{pgW7Uy>+pwou+KFt=;Hs1ZH!?F|ReNx{ZwnBtOt}+v59d`*!Sg>o5=^ zzyd5J=05c*;ooe9E_BmR0?HTPVc^c#kGn(HIiOhIwVq>YjIFb>ESPV*0|;D5oRNU+ zOjE2D@0<0tnam(=-rwhQhFEAzSVfV?6HM`01o(Z)_qb2P>V1M|tSq$~9JKpZy!E>K zOLgsMRUU|myCS%9Iy=?uR)Oi`&j{DSHd#SuzCA%A3`dQwr_A&@T`9RvUt|;rN|%#Z zNers)EbUn2$v>)((K&6|MK&BXI*n}Gx`*iGKCDuCEQOyPGLGO)uCe9XWU(;L&)&W_ zO(D_~dV8`}-#2U3KNIcY!asJvod(c_X&UNbwMl{0T_Y+ftRa%uN5r(UC{8Cyp4A$k z{6^00n)yc`5nIW3;P89GrpJbIK zKk9Wk+~p5s=pWM0Rw)buWs)xt%Eiq3mb3DU(?H1mQk+x*x*< zo6uwW$4m;uy;!?57x;1JxTUNMk<*3&@gRZXB$$pMbfP&upQC@;)0|c2zyOMZ4&vvx zbd>8OcfEoL$YJP#buVjAD)Stx@uW}~%ji8c*p7#Dil-|wqq)|ojR8mJ_9;Sk3Bp3z zEz7uk1{tDv->gv?_4rHO1>O#`73f?Wo@x^U1?R+P7B{lk3YVtY_pSTda0u5FaOJ|x z`sJ#OAnMKpn2m3YI_Ps-OKpP%sw_ahw2`^Q=XpsnT^(9Cnv^#cfzwgbX04&YlxZ)S z7{3~ohc0ixI``WlK!!}JI0O`w72-mLD=)J7?VDG^+eVQI5>ou*#ZwosGs#?pM94EL zbGA8*4Hx=>?|kdF&n^SR1dH`exN=%$WA&DBUe(oZ#!n`j_kHFbEg-ZzZ8uhA!ZBB( zbd1%jXsL1J(c`NLFGJc!JIA*xzl-6QiPJPCvK1Up)cV=kwn-P8U+$zmVUanQH6=+v zaLYHeN`+2qCZCWYcn9g@9~V|n- z3yr3cFMnf}QkuQQ$Y^Hw8jakSBtAYbF?PQgUd)=<{bf-&^$JBM&kLFL8-w+brt17! zV-}WKS$xQTz>+7rZk6VC=%9H+?s^Rd3~087NJYVQ!gB$Mi7!^=vVy}_TCl9k?;Kit z`kIM*qqZcN+6&ras~uhVAMD2CgxZ}CFlE}>!BE|gGD(7Gm4jEozaRZ~AevRr^eZwJ zJ)S?)6;Bue3Euxum;OI!?f?A!*Oz}3f++8!uL4{^TH?1Vr|u)l(z`lcqx262$dy-1 z1D69BMj^^WtWx!N>j))eFr@F@0A!1SM$j$(JuVUz@IvT3i2NRz9BL2BhXEbdeP zfn18}hr_6CIg_I2BQy;8yuQVWzSRDz9 zjlN2K2L#!G%^I_HaUR@5^XJg%dOm>-=puIGUb4rdKE2H*6vCjj2DS{rG-Rt&$$N2} z8gdMqxaaW3?NZ!u!LNs;CU&8GKxdqFjb|I7JG~zd8?A1o4SgmCsN_FyD2>1WE6inh z4B#BBH`#wV+;9k!4|w*JMnu;->I5qS6DtsZJpJjLL^kr^yJ~2-gBkaM0sz8%%T5B* zWblAR!*{Y7Y%o?;m+MRt4yHmhHSAiXuUpf}%Ou)HP)@m?t1u2y5W_9UMlD;0_X_!* z>#vXazF~^E;afqacdFKFl>!b>}h5sk!GK-G z#nQbtSum%@ni}KyXI1+HU*jewwA5QxVQN=f^7^jkSdTrP`V-oy87bAext)!?XC!dB zI)(ZvffTUf+cJTxAbS0g9v$|oW; zSAMH=3$Mvg?l#+rO%3TyvYD36D9pI7DtlN~?((dj2wBpV`R%Lj=9H$)73_$io6;sq z&si2)6yr~l$qF28I@%ZvlUD11h}i877|mUU1vXSJngRyrkIqr5Ad9Fl99th-ldgsA zMi0y9Wc?cW^y$+^#>I})*hJtVkVR#qu@;m(L!ZHrgMj@WHy~s@FUy9+c`ObsI~;wu znlH~!iR1k_^k>NHmK7^&*?A_nd9+DatPn=S@jf>s>mnIqoAW&FFp}&mze3`-S*%4K zv2#55fNEK7m70bJ@Fk*mlVNGe=!ypT-J%z?Y) z#KiQtB(_hD$x*#t)~)4TCEd_!qr5zBsNIVXzcN|hCIU1uwR7!8p}#>3(Y>8%mtP|l zP&w+W(NjPc`1#2}(7}c^HJfjev{!qPX!;tNl$_?()?nasJix~8yg^~n^Gh_f#i;|4 zAL}sYIV6nK5Tk>(v5ozgCu4Z*<8r>ddmGB?uqEE zbS5?BA&?VVAbwFBn~h6l`fHbGc}wA`V%Ez+OZ&xrAYm=h%Kn{%8f=H!X1rnFyXWvo z2ET-15+peZfHlma*O(ZBq_V}3XaOK8$)#F&y(Yzs(+FyLSZdNL2WN(01?Caag4=tx%9u=^kCnP&t2UJ>D0z>57IwbpSGL zr{Tp45;16gB$2;W&|eS2nvXZ8za|QVW#;FzSWbi#-)P^I^H0s-PlyeriP=%OBRZk$ zLnBjF>lQxyua{`=oI6G3PWt`3AeJw0{eY~v$>&eY!rmpfnanP*j^R!ojNU<~#8y-f zuQGA$Tw-~~E=|9F&ANyu(fC~iKWvVcl%{%;B&+P7Cc}rx57D{3PfRPRHj?>~MR~nv zGY-=+@p!N%#~V0J^Ek*U6|*D%@cbiam4SK#fBl=QaCUFb2h2HnNyzW6u-zc*r)-Uh zs7aVJ%&R)yxfZ9-yA&KY*=_*}(cYbIjL6iunb!M2uV=ZK+X`K;sqh&I(^o$AEdeD2 zw6=~N&MTHW*1Eg)%E++7*q5+E-3yhlZox{ld{i!e%wH`N4IxFStg-&oEH;H!llMxC z4(Qr(r%#=BIS=%M_ImsR0$eq5SsIMLnapR!OWs(V7Jv2)`U1l$-Q5@RvAzO3PR|GL z_23&=si|;QMW5vqEbDu>Ov~O8n^G9E12pO>Y@IHm($6l)5mLm^9;nVJ)k_= zF<-T(Rk=pC>Db71)#w%ctt!-IgDRaCUx>=cCTXX-V70{M?_WcBhx%`dd2Z*TaxUYq z_PKYb2ANdK4Z2}ZjM`}w%Sgy&WM}52k$I*nAxySF@XCO9{E)h4g1N}&YhN7~IiBug z&eOovj4tGpcUj-P{lA+kJRToRM!{u=-~+#ula`ltrXsktH@7`6y@SB|*5`dVbsuqY z$qBwY>BB64uEyvvyr_R^q_hX>WaG=oSTNu-EbMb!0>X2O8i9^ zE`Ms@d-U6Au86pe=TCk>VgaxuA?V8R^^j_5<-L#Miav59tNv@ru~z?37m0@)Iivvm z0&>aqns@?dlu3jD=G0#iR#s0`Wa+4tLm9sHzQj1+{K;vpRB4mxQwQzV;3B0JC0%nk z?QXhMy$+}tMuj-<1%~H?l4-8*{e0>ZC(;~8tr1=IolWCvNY8-&{-#rY#%aq_+-!Q4pz1J>ViqyZ!2Uln3y3gr`fKtXnc)?SoY~j$Qmq zPHTi=iSDztZ@`M`9ugbPu<|FMiSlcfPN>(V&p^c*=k4k^4z22C9=5Y`g$bL4$rO*F zb61|&G;8KZjD1FeDpjGgy(U}Rho)b?^kzC0Z6E4k6j<-Hp6_ zDNEq8HUn5*OOIdP(5By9{bH5xtDiIk|7q~S2m+pe*Wl;=2_#bWKA^>IlhPu(Yx9i5 zu6wKd{*xrA633<`fe(2ONs!X2%*@8)>^Y|ss)82qzTo^TkwoL&3PIj0jPNc;Rd}?+ z!JRm_7nxzzNEHIvH$xV73I(MHMuZ?$v=E}#ZK#D-x3t8cef_FZX-V#oW8{&$9_OiG zSx!H!ZF$H4Mu6q9hyr6b%!~KO!F3g84ZK_NV+dHm>ahkVj7;&Ysx=?ELm^LS!`AIG zd|k0C(@K|vf6?O6>EKE%l)FR^xVZ z%htl3Dd}hH1`_W+rxTi|E<>XmWWK4hs`%2pG8b5l7KCpmdS!fmNf~rr^)$}|b(O|oN zyv>(-E`YpDD!pB}U-kX(%aoDdJ4!bfzp%5`!TPsuhgE?2^(b%Od;aCG|K&$A$@9IQ zsD*p=cfu@9wxxc|EK=53f3I+2dB3enSH|YA`#B`K{lU$y-W{x=Yk1$38|+2ouPg$J zRlO7Kw|nn@#5lpt^O>|3_B(c*Z;jLOtg|wb?NAjq$?VzO^>pg#DJCtr<6Y?2A`6T8 z8O426fWy2}Be!B3Clshru;+rdPt%?E7L)`h53<=;p4%IMF09hN^nG8{z=sMER4!1s z@v=wS6r9BC`E0AZD4KV2^NC8;aS+~1*<3g7&;416O&YqTNn|_O?HvvZ)jlANO?=$E zYrE7?oYwLQ&r#a1?FW;I9$~NUwhW@y;2CaPjO7siI9Wvxouugrw^;+%W_YZJBk7V5 z4W<0+eCAWKYLEBOF(u8UcKi9H!mql;_AKO+k}+}XS6td^<2?kfaBLHLc9C#tn+C0_ zKs&q2`xs)|_f849f z{(d0*fp|dWs-gWGGldtcXPkm+(zfEFIZpao2!$R08@&cDxf9fw0lM~Ry4JXbm`J(1 zsh)5Hq3A95@vACr&lCbAEpD#sMNUx7iECbo_BaCjbk1#h;H=Ve@TG$$eEj0Fbr7w< zr(rg898sAQ4Eo`P8+l$}@0MG&L;Jv6WX)+rVVRL5eq5J_A0`2iCd7Nz4P~9XYQPdb zh7Oi&t3EOSk#CtBwOzw`T3k=W!*QEN-iX1Zi6}O*{>iHX2wcE=+8po4Gu;<`z9;-u zWzs%Y1Am!M_?i`C2D#;2ZPOUrdMQJMgajfRXenymsk`?#9Rz=|EL0G; zdXa3D)YQ^+V6;|JW!hh@m@>x}t$kV8o#G7r?R9rBJ@L%bgtn}ZkssdF#3O%ME_`TI^@C^QwM+9cObLn~!5}kKx8s3rjwo zKUCQ|CCGc=eP!uKc;l`g27OCUF@Uc0)pU&;*vB{RE~66^`L26xzY?FeWkTDy{^4SV zd+#aRRw3a@<7b)PL{^!@erCYgcSC~DU`m6YE3X2KlKHihZ zkFhWT1u9}9A+D(<7^@z`~Ks63C{ku%`y&#?{;4(%jk+AZ{`A^&Pn!-D;id zkkJLoFs9$Ue7jwy69=+3u+sV*koV%dgh_=4xM zi&o|?k&+LDH8sC$?y2&YI3)V^2BZ zW{T(5ZU~q$uPhH}o-|^Hb>0mTpK(>`ln@|OMI8heaBp?LZ_erOtICU)+zBJ=i+PxD z+X(H-yESgya&FiJs~Sjbk)C~_$P+-fi35)vZ(gnKW}FFcxGchw5H4p;^AQ~G?=>yP zu9D#1ph5#C^-@o{-IFVW*Of)oGYvyiWj;~Pon}xfmog*QA(fijg%aN{ny|^y{_#Nb z^b{)IhWFzCQ6XPm05{!V9}z|73$MjPZ>!)U!rtGdb(ZdYD8(Yn)01)MOD>f0s}zrP z0?74UfjzG2mVV-`@GmJ7L6l1S4+0Xp6TXU9v87O|sQm6i?n~Xyy&Q<<%Nv6^)z8%w zrq_9Q?|fm^9E3Ka27iSTq}htb_Vd)QigFe7=Y|nbCw%QDb1x&)FR)pxrdt`fgyQmt zN_;cAYq=iRKfL0|uR!x1LeZAM^XYinugjD*M;GqyOho*7i@q4kK zE!Vjj_?}&Q@;lm$eU+k-;qm)r9x&o;;fp4&D$zU^#qAdz@W%B|&#(SX%M24$3ffLt z_9CcTF@=XPtj5u|@ zdQyMm4a8aTv#0*mnl0sVys4{zKXYkFhBSrba0)Z>H^K1#H1yVW_7iLg?FzB4qUq@tM3EMI^8jj*+fqP z1hf*LlS+v()ksuke9#zX&nA5C-#qJ`c#8-pT4Q~ecF;b;@Jr`ImBg5?fwu{T z@nk+man{MgV-4Sg$)3sjKTE4Y9Xr)6e%~JO)chKyk01K+#Lp__`l@se5*~n8)s{Hb zIYd2fCLY?Qu&|FPSZ18bM5LHoCT^2>@`JFJ@5CNhZq*G^k-btc#8BC%Bl_-I>1+Xi z6Y_kZtGXRq>`+j(QGML?+x}D4sUmLVJ39~oRS9$ z($;-U)fI%d3_;3i{mDzfzZOp?!UfLVj$4EkpB2oO`}1%fX{LESA173BN!%#UpWdq> za}$Q((W!qCxc;S}EmRzZ9NI1rDBQnU?8bb$OMC2uk*6B3eIJ(NbXeXx7>;hOk91r$ z*`4gRHK=;;66QIN>Bc6GIgP9x3*s{xFMc7jg(?~sxBd96K>g?*ZxXx=mdA6a{CxKd zWi^iv?#+J&p~k(W!gGN;VU02wU~8&P+{~`f;P%?2#5ryK1-SeY^#${54w2EMUv74I zrDQX=TY;)D?-6R^<8vNw!k?0NCW5;o@2V7zVi~OpvRGXZ^c)rQgy}p9KD}{tA7p zDeCh6x!O|dfht}feZtPf!`ghyi0(J$arGumDc9|fo`LYcRT!Pe|JdRl)6)3p%)EEH ze43WsQTX8Z)2f!l%7(QRJL%uI-HRa>6#Z-daOqV)WQw_g$>!FP_N#W=vzx0@eZHZ* zh8Atjg(97XWZq&;5iMl+#r0Wzl&M$)0s>?ngCFTVFkeu1=eI?7j<@-YG~4lAC;4n( zsTXQ_{dAZeW21|uxSG>;HnR%-EbwWaSxOu`M@KUu-U-L<+`X-?1<(>pkCjX3QrC%N z-!svs-H&z3=v;qK^pclNj)z~a%YrhVeqPv3m%!deswD{5YjaE0?jl7O?;&)(kF^dx zI|?cxoE8G5%)@qgHRuc)TFwNdz0#Dan~q98>P5l|56T}1>zia_W^q<5r4 z2#AV^C_$uGQEDimw-ACLz4uN~IsrmUA_;-BvcJ8zIpZ)sZ~n{wZjLq9n)8`YZ*#7W zw!o~rmY+6>0k&x2t;_)a%giR(r3;>Fro$E~Tte6ruiSL;x*!qVG$qOly~Kg>np&{c zz>@GnXaM^*<`Cj#wq*Id%kNssvAJem;fESC`DC{cp3b%p0o{qiWz`kIWSMH%hLM;; zODLm80oz7gl2mE4q#D3ADuntuz^^kO-rXp+8Vgp5T;tpW!m1dB5ZJq&2{_SvU;KMk zo9;f(3A}VY4<3lso}et6qyMIlOsQNJ`-y2r4m`clQ;(y|`d zY_Dl*u84RaQl&EJM(R5$m2^%$LqWJSBkSuRG{;3a;@4DGOy`no=RLDpDLvIs*2Kh+ zP+xiL%AOS^gPbKf*sAfucE)Sh(0l>gqk&1`-GXsM>otuIzwGz%$gqk?Paaj3ak0)7 z-q+xs+_fQ?zedJk7!bu2(S@EG9=djpnAnGWzM{$#u_)m&@^dyYne> z6O>yaeu6rUwR+V3}H=HFI^h-_(1mZ}SkmPu>}pPye3s)USe)k4ct18Pob6jLk3q$lbgq zdFcBcw1dte1$=LRHI_G;>x9TSTjibsrIm6BC+QzmgMb8i#+k= zp3GWylxz-$Ok9b?H|(>PvaVh#{ZytMasj{fWuM6hOcG6X->T3{ZZ{d!(i`?5g8t?A zR1=YbA;Q+3SEHqv+;L2h(Yz;EPqUvM^PqA;%`Fv-0^n3%17c2h0yZZb4@u=#wO(@7 zcCbO4x?(D(GSQuNrBhwr%jYeh z8Bdq*BnI!)B@1@%^d?lXhs{yxb^SYm?0_$%(f15@v(@9ql%qYurOVXly?9jv({*^= zOu?!Vw818Y?GkGzRy(L|rc7$=r`R{UI{U&x=X(uzbYlXDaLcKp9=ja6hh1+uPv)YR z*zVkR9Lj_}9<7c&Ci$ygK=?;Sz22HVWR1_uRQs9P;^Q9xe+5n4m1I)w{fMbflx%NA zEZwSVH(SmNF??5%8Om;<#+*;*{JA+i@){QXf~noG@I%yU55{2lExF@q{-Z(8WpS^tRN5+FHkuL*}XXgD=ed`ZZfSUT{`cU@hY7 zT1#HnqA1f^-M4^>Nic%~B>?LlyybNCPUrj2KeyAy;?N7BtIfN}xQa25*4|i_zo129 zOF<~ZFG2FODF)+7#D(BON6&5n_Q@jPUFE(1EoTJqTp#M6pk_;-BV8%7{NK=*dC=WS z7C;Hr-CELjISQ2|>X76CT|UeEwC0`r{Ob@V)o$ivEkIP4{-~_2*nf@%VuqROR<5mC z$n@5Q60q_*%ZFq+cMvqt%pywBHEn7De!5k~eFc1>Z2R$T;V(To*`h2;G zyWSnntDYq;-H)0cfmHY-Ofr+m@g3MgiGVKZKX66>PwTz<$NcHn{} zDlpeQ*lHYo!{B5zvq`9yTA8sucH|{S9vzXzBr_G@&d)!cqTmtyT^ZxD@H{V=u01fC z4IMD;C>5VuD&n_zJD%8;9J#T5!Uj2fq3>jDUZkR`o-|l5x#_X7=FjbtK&F^0Sp*0n zs>Gj;*H_KE8*0irC^7)=`v!lQ(^)g6w8ci0>L#AgR9%~poP8^%wz@O|a2=|?b{x)vUEN@Zi2f0)U9O$07) zzu=l@%4@vu$2;&hux@bk?xq_;pex>{+vH~I$4gul6Fz07HJf+i3FEgeTYw=o#4e+`zDM{K zFL`y6;*BS}-~!treP=R}v8$-pSTm?O&!FVJK^32X%h^!*!hXqUX&|5V6wDv{`7ItU z?X>;sa{YSlKN$~P_|`|O6&LMaSZB8i+Wul**-Y32n;FNZBV#TLVgv< za>7CWJZTbnZA}nkqpo){uW~1>u&L?PrRBDYPqi3Q!eGTPE|f$u0TLAbw=9gka<=QT zx~fe_YOF%Q_q|L9=wLJv>!LQjKl!8DJ+9&RDRMPViPm=)QbEPgX6NpIig(C~k{VZY zT!%IFG_LV^BnVj?wd*ad^%wPmNAW$?Nf4K2z9I(Gu$P!P_3e=#X1TtT6Ja*j_cHNR z@$)^#+};h@r-A6s?jX^?_Uacd5{V_u0z6#haCN!XL!xm4XNp<( z^p-4IsP`x^J;XaWB{(vd@@se!aXCUHH#7baGlIbaj(+z2p7)oP+#-3StKB8$;4%-h zEVFFYvW;B11v$B*_J9<=-|>_-cHNOh7dy=?_?6-m9N0mu71Zd}UetJAMx!D}g=e&u zn9U}qohA;F%JZ}?zhbx%(m&;rlytO!ert?Lr%GFQt@B!iF{Ym3QfhAGvc0q54KI}! zB^;=L=R~Q|J53D0iTB^Z5PSfU`09H_wO(>gG@TeJFYdm8w=hDp;Bv8Bg?C82C%u*^ zYCSYw;qa><(k0<1ITgpqL(yjjNBqUj69&SJ1Psde=C1q#T@h{`#w8Px;)4rAR~T2` zhrlDhFmTOxd{Sds7{3Ks_~6;K8ZbZL$v#%0WbeeWwxV}3fVjdW(`4299Fr*R%G~q# z2>(1T(yxHY#qihmG*LPoegp1mx0Q)cS82SfPENn|qdB!SD_4*et@-{+5^gklczY~` zvD?KM$Z@g7=nhvs@0|bg-CMZFX75pV0!ou$^qrFV(S8(cEm-v6_h8^5}nl#n?3f;oM1d=UUqbzMg7t%%Sd{94XAuWv;pP z`h8&yCj>H3UWT<$2z(sSk)Vbjir4=4%vVGK{c)K`zP|^z2fFbA4e-0sPmiL8w155j zb-3$}bNz*Q5xh9k?HhbLTW;&(tr!hCj@wQMluChKp zmqNCCi&JxGt#XgnmwR8UzS6<0m3w7E{-qJ^r5wN+-B^paIup%U!c1PB#is{58S0&F zexGp_qp4>9v?jUfcrP-?+-P-ez9-Qx4c{$NjrK@|WdkUt^NoUPkde?C3`ssUjJ<`sWV9pF1HQ+cotSQf7C6FDSIYF)LTc{2+yq}W9+z6}d1MY! zT%pwu$q>obX3|jLlii&Q@6+w56q}BBNB6@wr-!&p(#O8HRRw{ZB!>qHucOWuLYkR z%M#mXk838Gm=&(B*|(T>I~7`V)}`CC<|L1zcUV^oZmu{x=tg-S19|>4i5M&PWtw!! z%#+L@e4FZi13eq?$r=AO0;KISG`GHWz_n`{Sc1N?H`ZkxI2JMfug#aKZS^ z*Hb&nZL$2fO;Y_vrVxB`1pgN=lVm(q-ZS%G8!yL2-O?><&@)}RA+JUPXHxdEjQgvr zCR|N&k5CldUjuHNTqpcFNyd7xy0zcBeNFb*D_vd@1->=c;59vZcK)c_KMlCGfSiKq z)wAfHXtO&Ff){Mdy+cw5su~zg;wjk{gFLD!^;%moRB zJ*-Bekxpi^1=SvM*6Z!3JV>a90NmSU+`~-cF5$G)s(J(1QJpyt4fnhPcc4<7F;Jw~ z8*a0y89o+p_A_mdXDXSuDU9H4!ghdlaKII?QNgM(U)Clzn6XJ<**X8J-$w^sYt zv`5Jezf+~p zZP(i10+uGdBW6qBR|(ku&QY{4*6Z^AjLvAKU2c>B*m%tFXVZC}Usmf8uvG>y%1_2l z5BQmn@>_cE>E2Toi~aGSZv)%0!TD_;81r)!D00>}e;`brmm}#^<~K|ap`NXF7QP!z zg~;j`He+j+^@*ivz_H`#s{OnuuVL}n%3JZ1CLzXzllPXU&0Cnxjn)a?%zCZRZ`1Ml zTXXpMeL>K(Tj1hsANmcC;~HR3Z4U5HHSpPvXkn$ErMd=`qsgFVFsj%ltOPD2wkac0 z1QL^#mPYpquCT0JayKi~Odi!mkWm%^hi(biLH8E}R88rKzLogD9cl?F_P(6;d5s=%90=;#xBmQJwBS_uP=A8k%A|7tM@`?}^ z8Z<(6<&^uPlm)cnaDuguFps6&?>ZggvU%Om4vXp7eA^Q+i31@L6Bo;a>r`K}?2$`$cJVv+3}% z_)%`72^Y#o2dwAuajkeNt;L=h3;d1Nn*X9Tbj+p1vSWl}ZZq@aEP)_?W6>n|5^{Ud zLC@9S;a=(yGXCgbK`iKl&L9Uwo)~rEww5wZrQF4P`f2hHeu*M6J?+uYw_V4Up7k5# z2J9X_XK$t@Zw-3n9cXGErI~gP0r4W{#46B3YDhag`?t@f@>Z-}d)jY+eT^a!PgX2h zeBE$5+CLG*Z(?%WCj5$eqXy!iFSY8jl)MCWLs^C8^Y)}E*R?c9^6+(sw9T&wo)IA_ z+sk=s*U2@nf<9eAj4j`@z25AbEUsTU%->VPr{O-zp(ik1y2g+`FB}_(9Z24nuzI^P z9;oTTEs4PPI(6bSaVeL7xF1sn7dkh>@rQ6Jl7mIQawzs&vw6Tjwxk49FIJU%YD@pf zC34S=BjBdlLYhr&QVASv%G(U1BsEd?G2*G`_?HBz^EchWBj)8$|!_DPGI zfxK!>R=mi$?(^xpB->x8cKqS3d(%SCi>Ht6$}Vv1_|J;>6$Us}?N2eCV8O||_N3HG zc^4#Y`eE2l5U`BYaIIuPAj)XmgiBA%g%6Ig;@5o~w7Zku%Z<;=L44z20%C0IcPhaw z^UO8cW?w06&Y%+8HxCZ0`v)lMF>jA$l~;AMs%QV;|1mRI!8GW*sy*HjP;QgUm*_@m zw<~xMkZ)+r^1@STGU)R4Qx|s!njg-L``-ZQDVl-XzU-diH|OT%spKgKk}?th^+NJ| zV22z^+COtlBbg98kn^5GQC5yb#lljv#7rUK3M!MW>&WZVfHBMC^ zU4c?Bv?|qe@P^Ls4z^P=36iO|T89O`IC!4{ueu(~srQXNEG4W9ls4M)rp>pkV-c|cE05r;>ru=9cssan!+%_+1_QgKM!A>j3lw9Js7hZC&E-JH7CQ|M($)H zscCE6&;#ew3!@C9p}9fiNiQe$LfbtPEpz;Q=W>`I@invq?UGnB9OESUI^_Cmytm?K zKV5F@;S&j#ZBb7*XWKqKlV*+71Eg`2)F=Hn`d>EzUhHF}^V2W0M%9RJpU*KaN|K@c zraMF)Xv^$0n#146J&y0=o*flPKDVOBdhxcwRa~IVgSHr6-pQ1JhqYHIsE%ESlzuUb zrVo8vqde*QcXgmTX-dR}#kZqw&-RFJQhV7K>~^AlfNm{Ju@N@oe{&VPFB`c%C$|;C zP7K|74L-}ipW&^%*4Fu2wB!}g%nn&zcjonIREW&i|M&&C&}|YO$f=~;x$Vfj<~#Tu zvQK)zgh;qr#V7vxaO~8~sF{}74e$McVK3W3k5S@qb|FqxRsncR>lZ^*QPZ?}>!sL! zgaZV*j0u=$Qo7jJW|;T>f*szYW$$$g&=st~HfANO!0~7|&!!E`$%l*c8`>H|^UfmA zqHRzsJCtwlrkwE3S1{!=d3#(LI=JOEj9iojE3*$fdWLzBYoiS~QzwYOVt`M&*X zu#ub-a5#d(SvxGsj;S5+)6KIHugAQrJe-j}J$IU$go_(4%XVrr$C+_)1uP5-CtnHV z0GKq=&y;fOMj3~^c3EFTwM_9g^Ok;GnQxN zu}`2YEL$SJk7ixmjvB_>>&1ph9o1FUA;Yf7-awhM-{i?(_7)^AUz2pVjP2?sM8Bfn zY~PyX_ze85^&NcA2fTH|4XZYsqwt%iy)wcQh`%4-NT>Tt0`rWrH8oKGXV*V<&ux18 zs_*tsNQO1O?U0Sn+{dfMPGt3}{S-o9;r-;7Q2V(+4yIV{cHLH4?}=;s_QqynPNO#v zr*~7&yUKVjN68GXa_1OkypkDR+B?!*a_A2(f__kAv=1!JG!PybtkpGM06geZV`%kM zUX1_#XUpywHPgk7H?!@D&2sH;QUhW*cr-re8O&Ht=gKOosjcq)M|oUJiLpQwhEU#NP?m^8S*_e0eXA+E-V0_NO0BU!C$H04&~@ zUA#2&(ID?nxW#!5c=7Cu-b*yxSIP?rol`i!ckmzLA2hmWNUbNuJo*f|Pcz{sV4vqt zG@JjGF1-LLksK2Tjyh46ITrQ$4{- zW9rO-4WByy-kN4Y8t(cd^bya2m9;;loTp)jGt$((*xaf-_m`E=tOHKg;%dDv&3k>( z05l$=6BD;+pg9PN94)}^!mo%4u+Xr`B9%@BJgC3rHScXxlSr5-b{alZ_M~oQGU5d- z77yBVx-@{A0TW`Wj%MWM^2JsU4#x7X4I*Mu^xcq_A60Bd0#A4^S)iB0!?6D{Xa|Iz*?RKC3!*x2Fz0>6LT2Zjp2mGxrR)UW&19^}rIlaPCSW zUIbh!CIG#v9k^p+y(_7A*U*BzA`DY8Hja6j*(>Gpe5zF$Lw)g6Vg-n~6s z>U=d;49@Ht-CG#GT_M*;IK=Fjw@w`S$6PcW;L(VOA_r=KKPu;+pbG$h$JNsn0$ESr zVFqbuOqJ1H>yDcWM^P7C6$3kxZhvd~aB^hc)Xq8ha3^On1Z`S-X+hEZ+Ed~=(>^{tnbitoW1`Lg97m$n3{>N#mrYd=B zt@zbjK?3VaUgF8%{4>A8WTg`m&*yc=S18L-egU4JR2FG*YbsFV81Osqa+KP>`|j@( zmt|%xMr%BgsK>IW{W?^mZ(5IAw#R_QH9(lOsT^AajRYx^Cbc;G#JHi@fn07PX8h_j zTj-E47u!tfZ-EfM5P23t25^Y0gXjyL4ML`?=iAqkQC`_-dZ-y>d{lH1&kR_fI&UtP z1+@<8%S*yPCmx;>e6ml`*dZZL5I|G^Q(M@2nfvjrXF3}Hsr+>1^cMfFEJ4fMNCJ@M zhNoX?h3r6qN~e>FPjE67tP#g8!)qJQPTz0#ORsEOxuG!#Y^fF zk-d#lFsX%C!K!oLG?YfO0>AbLrW;1Tcia7OVrRCbx7cHcFSp(zz_&_|nK<_tSL@Q2 zf+FX=e-l0TeSgCF7*{O9m`h=b+~G{@p?E8!q(l#ghvK7w5U@S=8=4vPuAc)@XQ9=s zi_eEEb&(*o**(*%Y|f>8`_VD^<6bSw*j=o+<3-RrtPjSCbob#nobLln-YvDnMDUGY zijFimxI_stys9u}a41bz&%{|U7w#dSbb1~&RS{w`**|4Y*&2-FSmDfr{~krP2WH&c z^N;BcSlXW_dj;}M_(8~C)xJ*xL&)li4M3<5_^h^&3HRpPUU*56rD3sSw7+fes!mI3 zzXDM?p9OrS#5PG>$Ra6bYR(n&GeEaY2VaZ#$^0BuI(2{R8y$R}@C-}!Djmm)JMDgf zd_FY!azS~{Z#|I^Kl}RR=X}nM0Xt#E;3j-C|N13Hta2ch%L#$NP&zRd6-V1Y0j}nU zhhgOhQjJC{N1UT-?FW-mS@0HOU#`pOA#{79NbxIXVHu!Fu3G2$>p(yWzAxIJCa&7$ z;Yu@KI1QzzaY5P=9_{SNQC6RY!rij#1DC&LKF|g450theY6nd2+O*AH5w;k*va^Zh zSXs(Pdha1hWJQ7VFAtRhrA;^I+POsYa`J5UM7wKkO6sX3GsvD!W4I=Z*KdBA;|_kN zLZ79>-6(E`n=7;%ZqM6z+P`{ZUU)AnXS08HNvk_SYv-y33GupO?>~0|I6yUq%k2c5 z5KdO!2tG+KXl*K6m-ZkR81$IZJ9r#?$FavjHa`b4vt1BJVIn5Ke~VA&?YEqO$*X>D z!p}MLuP^R>*tO52IGRkAega)Y^^Sr*ZatD}vRgG_BC@TKjO8W0b}R8KhTu!zG}CnS z2-=6{p~slU(D4Arr>BSu;Vjd;-)!A$TC68?z# zR9V&`UClGNm*V)cn?UhQZhD?7mLAyU4tKyE?$6Sx!Z0G3f zf?pZ~Ea}zDJnAVo_;rC(JZk9sK>psbLht7w@b3fe;|B0#em%tJ3Jlu~dnqT-b8zaY zJ9C>2SJTM%uk0oqWffKXy`a@KbQVe!BC&2=AQZeQQ8T4NSpT?DItPM}2lc)ZV@Cj%OX)YCJ@c9?xz5 zyqO6)syBG7v(7@KD>2UdZlBGy?~F|&M?s_yVeQZNo%ckR^e)S9#2yK1w$;xa51*yl zG1EZe4&;i(X(K-5mBX+c$GS@6zj!Tu)O_`&%N{_NN`XMegIB6C`GuK*Q!XJ3_Cwh$ zn!Os6O%pp|RwL`Z1h$>v=18oJ)QDbzBkvMno9l$m|5FT+?_oGxP;xk^TV^Lh=cd_> z??QA_q`H)toy)mUdTiyu?_L3bCv9Q*<2LvN{9T_#o}qzW-wYRAL017xo|SuR-+&K( zcqUCjY2}Vn=ySz~vKsb=FF^nFr8ek}ERQmqmgosO>1cRpf`Npk@OEeH`8T(~$G0{F zP^%Oi)0#sd_D(N;*qC?N1R9O%q;$hR2YfnlJ}|m`*m&;p5%-FZjaF!HK9->XB4lOc zg>NT(Iw$jW;ASs5!+wrIy&q6}eM0K(xMGZSUO*Ud+S5{FG9VfB%(&V=`igwO1A86B ztuhB)@5A+e&pZ^>%ho`@hCs*0OKT<=u2+0o8$vGpOBtTuQh!8xvPf2E#EdoM0V>eJ zbN|!s5FlMxTy22$4kU>srFI1Q2yhq0Zy2Bbn`?N4>alMt7l|Tzq6!4&yr0I3JK3sP zLCg)GgFO*u`)OWVDUcv!%;RFAv##AQ2CewI15sQc{VWEnY0RItAa=ndz)FL)6?r|gEc|&SYVZnJjMXig zpDBBkl-MN6;xHz^_~EaxLG3%@sM4SbPjaW9JA8-Wmo?DHGdOl+q#POxvfoqE%{O(? zIEEnP{_}#_A;HJwyS9_+vhR7}CfWXVI(oX}sXuE3Y*kwe8Uzn~Nlsr8}>(xHSO>DqMT-#!FaL zL+8XzhqVfvC+n+Dg3UFccP(3{9o+@55Bp|P#8jK~`}q_5vCHncOA7x=IJA?8Udj>X zvyiCkd`ZN4Eb6+$ki_J`&YpdT#13@camlqE-?zINC^@d(|H@3CPqIn3DtjZ4`1)tD zW1~ILu$C=@SuJ{L^Rpd+jumwfQ(giRk;OMYUe_x~(tYWi{GlwfTGztzsIX@$$yX~4 zsW;`*%#b}_@d|Dt6Y|v?Bfi@9+TL&qIPlrNFL%Wm%wxiR+PkLT?`7qA!HT?f8;#L%37s3{zyXcU7o-)zPl?52|BgEX=LZ|m~E$fa5kcFZv4FzkDQ zq%rmx^dZTJ!x^&2eoWiO>?RQBro9<~{mG&nJmS3#gtQq-)4MxdjA}XW)iu1Jy-e9T z)A0s#ow#zqlmHFA6s)`$%IjinV?%%$b`v#wYY2Nv-WPRj+MuV-9{+8cFd** ze&%S>_~c+{auo=qrM~a!W6mr|XRPsD!D z{^<(YK-lY?5F2U{kKGhYa zRyB6XnGSPp^J>u3tAGazA(?=Rwaul8N*d5asuB2Yr~!$s6+`pp;80B0o3cROuE-jN0*QIW;PHu6y{Svr>{TYo`MgG~hT0YI z?j+xnbNzx%%0<_L(}&$PsuJ7#=795%r{9iW6#&hv4yIERtA#9|wq+)^+8DX&R!rQEIW6$t@`VCEXQ z@A)cxCiXBPkWA6oY~POmnpsc_^oy=S{iNK>?k<)AF?V@hmrye-weWSm{cFs?y!y-~ zlXbtWuU4`?EzQMNSf(AEg10J=x}iIwbFU z^2qlyWljmI;|@lntKdru(ZeAl;3EoP*3#4Oeg^K=YxS~>N9PW=j^mh0=%uD0iN;!J zT}?*N7bBF{>wy9TunxJh@|G95Nd8GwPQUf_>>kOj?y6$HPANNxiNn+WS$Ox5lXQmJ z{#C-}`Q$yWLAXw7?0>Qfree9_@O3ytQH-FTVYST07s{#Z4ZR>i(E8J>YM`MfA2|@- zDw9egd4ZSYM;R(90>DYS(%0^!WUaxuCIj+boM>}F@lr~k6wAU#j}QHuRDTMAsWdox zYOgN966qQ6uq~R`3b{(^I6kH_?}Rn1z#FeqCcv7LD2pf8@TQ!P;>uPFtAXt zO{{}fJbvwWqQM1_!Qa1qF0T)T=yE!Tuyyg8z$<0v2tltyR|CJu_;96 zY-g+>%yF!ylSu&%StV>Yc!7nH_xX041#e|IbLUv(!u{pOv7X~9_yzG*qDckjRy2Q% zwwmQ&0)De=U#<-Hbnt#VP~IJ{z!f)S*rVZ(vfzC=Fa{&fz@MU!svWCXl@O!xvG(Ou zMAI%O^{@dVmmzt%1iIi%CU0gk&JhT!D^`?l0vj@&nzwMx4G14}|N6k(9tBz0S1I}$ z?75|bUnNrWG-?L>q%ZreX$?w_=Rs1PpJb7aQ`M8EdKSNDzY(Qpa>anS5}vBuERkQ^ z{(b7F_Y_%2H_te?as^XhEa@g;@vVLlW-#b1oP0V3Mj{=P{sJGX?X3uzEe=4xh7KUJ zroP`t7=fRbm}b9+hle)(SB0YW#}=4z8^jzpqIJeZ||!+j-)oK>b2eEzn4{Svi$9V zv1cB`8{*{TRL;G)=`T9P_d_x!q9rC{Q=*E%pqcFpgKKh~b0N}z+v=d_Etbn0DPPj0 zOwWYRda`uRZR_K(gt=0g2{;9^G+1FdyoMUmnPtn%X>q{L6Dk-^sO{iSOP6MgWlukM z$W53m(=)r=qmBT=`tFo@y%78WL5ur+Xm#x?`Yo(=&YJXyG>8#9!=v8v?x}@U5nerK zDR)pQ1dOYixyb7$=eqnhtjQM~NX-KH$G%22EVEsfcK!;Su1-16(q*T1+Z3(ND9xGI z5Z>mtw%e#%2`Qx@Cl+?H6v0?V!jgG#Jh%tnISd)a#UPzZ|D6t~hfWq%=h4B$F+GnA zO+0<;tRA&XOo37)>s3fzO>~IuN(eLFU=tRr|YUz%6+%y2~fGg-_{?)wkQ;W?46cyzEdFGxiLCg6e?p{O%tnz|276!*um;>-Y;Gjsd6YXD7ZJ;34C0ANB=MC_@AIS zAjNm-b3?r%P3_I~1%L-rW0$VCf3|Y)=o3|&Pki8_*`KmI6`F|%Hw7AKXfnV5B|YDaquV>DEBfS z4WofDT@Qd}$#b^Kg$5d$ZT**6S};JG284BuX{&y%H-ME#ZI@{3-Ul%W(1CItcu^(7 zN&;$hiwp>8_hFX zJpGp$k5lc#C1nwsS_)@AHH^V>bx>$@>On#oL87wfp3p24&D6@&zK-kX`wr32{=h9< zF9BY(Jemoi0a5EU@ND3YiZRz;zFsl{z$UQ=uCde51$f4F`tV=AJpQ8^SVN!VYQgD0 zp9X~i9S$4UINfP+NVBQ`YR@yuk<{&NytqTNj2#t+W0#cH4*!|)pixjM)yCe22@q)v z)4e!=d<}2D{`G>x^f+MU3*Q!g&|vdNIPh%b^2vfD2dzi@tOg*JAF_~!je|U>PKgPl zxOmtfNjqqC4^Azk@r8U0qt#*60NCHKk6mb>IhZ}6fcW)_XDHE zw4@GTwwl$=nZ_^$y`ie6ghG1S?Hxp`=c>TRjvtTd(Hg7wR7pGQrT+e)ozgx#OI7gy zgk{ozl@6vVKu^mmL7KfBv~nMnETzIR6DMf6B$R3e7S(Hg@CMeRmd`Rh}CF zd$|Q;8m8eKT4?`33FIocy8kcXJ07IOewb#igCIWh&J);Mk=z4g4jPb|@4u{@QM@;Q z;m`C3k0P!EUqAje^NePhzPD5)2!&73)696#=XTV+8M2$KG5(=w5VhU!?FmI;nh6ht zTUiKLnfFn5D2;`D$41?Y@I_-<^dGeHaUVd_ZF`yX(?GaHP4-l?I6Ghb1IBPxZ6)c#pJxY;t^sG%E*-k4 zMuTl-s-w}r+~Q_-;Cg>nPN$N^&gNFtc^aagqvqjzJ+9DL`#zg zP;HGqJ6iz_=Nt?-ki%9=`M=tk|Ns6-8g~4zJMgb(|DW_nN(~*kxLcyUx9eUG{N71T z0G(%-XJYzrcxwjs*=i=U)2(q%E#uKg`?GAS7XRi4WfZ_k+PIMyb2K#m!#{sU>C9B2 zztfkcks4DlX?7gjAqv;~9Kv2Bm{%^MaydxYrmKz3dr}ZP|O}vWuzt=jj74{(Mqn^?{++CLg{K<65D!)NWIIW~G&Tm22$R^{B4Bxyk}Aw71ei->`! zvJ4;+-IyEV|1D3`UjawA#&#g-_`z)a2cC1h5o>fXrSkj;lxkM%&(1LJy*egIhx^u@ zMmlb>1-Ex{#bc8ib8kcr?cV_oX$5cTfRxZ0z>%NX;`W5!z)2(DppEl4+S;L*h)C|R z_7N9!O}4=P(#Yc&0TTfiH2$r~j^0d|-`cFyXt%t^=LNso>#<_aHx;HXM;K?Nnf;q$ z@2&!b5E8j$%Ki`bQZnRiY zhosh>oUSvyfg5$7+u*4l+ZGN;y=G8sseZn}b$jut-HSmy0p%~XBAa8-ARm=@!#OVT zKYV<3y+z?5H}(H|RwNMNOb2slB19{&UVI}eSJgiB`Mo%iA=gRb<2hCz8Q}KJT>|-u zq~~V(Zae&X9Iy6`orP4z&F*?dtuOZuRaJL_Bij@DBy|!es@$bxs{;2AJxxQcj(aNu zrRIEwQ0^6Yz-Y0R=h$NKB$7C?(4NE{CW8JNzcP+Cv+hpeaTqR$WdOB3ZqH2^A5I@n z#3YKje2NB6WA%PjTvzqs2iDI~^X_XPoREnKJIrswiN z%!kXu5+=B@GNX$E#qiXd0Wm{?Qg!c@k8i&;cDH7k_AG5fcil5*JLrMv5w)UA}<3%?mG z2^9r3&opbafNmEQ396~3?oMn8hQfbj$#VpX=m2=RP^^|bCc3In%R7wfXpGxd&bLi)vnztQ+LKwO z9sG!l>N5iF4_Gl-PEiV^B+pi43hlqx6;JuudleVJY39EX%{Gv9cj;Kx*I78&VRnND z*;WfB)2VCM`WyJ>W5V3X$;9#T<`3)wR_!rNwlfuXcf+3E-JU$XijCjy*GF4B{yXdp z5}`JFe>`=)B8b+a{=Z809?L~#@1SO`aorYpZ_w3B*XD{%CxlAZFK~m?+PDBqkP=8r z$Gll3nos{w`CYf!mb1Q)byi&~v=7hv;_wZi7y9{8dO>tv&SWZlF-v}4r%7r(n}Dsw z4(4+CZq1hS%XpD+uSuHSF2Jo&&2XHbr$ZP6(;gWkJ_H z)vgz#3c4msA6r0t=kw6XTa4t{K&@PBPY5JCZ~#ByOQiEEdCC>?xbgiQ9TRYwQmqWh zhuOx6(ZSGG)D&$5mh!x_QSC6^5(Z5v8NX#xZM@fC^cl5_PIFOdc#BWA7_6t>t2>5u zDTAT5!U>z(+ORRQw*mMnu6E&mmWC&jr@&xp^`p5mt9CJ@)AgX{U|sIkV;p`Ha%*H< zZPYpL_v7um{|QL!v;kjp?26tR!~d@CgG#SQtR03W2JUEj2_{8l3w_XyZnizbKFD~A zWkf?qvlqB}FKFAL#Aicm>G!k+!JN-^coME2#|80%n9y$wh;;JZ%6brFQOhm>w8fMX ztLR{S4~g@2!wRFqKBL7THwJ=ifEH*>IV73g8%-SE6j1C(!jYkCtqfG<}w7mXS25(ys4a(wKDiK75YrW zAYWHUSql~`1(WvKX?%yUZ0R}e!F=xV^o!>3WH$xm_=?4`(|)(_H)>>QU;MWjHAEkUyLqjw1h&9&WmOnY{f<_6B!>56s^6U2vQ;cuk9^p8p+3M z_f5eWa^%wv!(7l?DIaz>9iD32XCB3miugmJ4B+Xu~r5MUz^LMeUC1 z(cM4@@sJhRlW_WX22>aLlYC+01050jb02Sdmma5{r#QB(wDTs28NT;>2DZ^9y&q0TI@NI)hFqzE zZp%GO?PJXXF2Y6H;PPJ047`HaL6%GDw+F_eO!XzIRyNH)%}2fZ<~?aZ#xz#GnEBP3 zl@j`0DLF!R?L)u%2hkz@+tR68;KuDlgTRK)k}BeAKfl*l(Ymz26&R?znf=cCdLGLH z*Xc=+9ddKI`5R33GTkw@PbMiTbr#EoU4DUGQ<7f-arG|dxyvv@GJr7vKiQmzf|?l& zpJ-qG7Y+}=7=TR8w8NbO>%Ud5u1nY*rGwpO0PbSOO017$5o?PKhvn5a7Rq`aB&&R{ z_m30ec+=sXqMMi+K$5J^uev`pH&LST5v*q-i9va!z^`V)-?iVGlzeOA`PfUA!{?S> zZ{dJ115ab!%yMo%i%qic<^@B=bd~UK`F$;2wvGIXsZiq7K4+iq_zoBSp4K|T=gIB$ zxYKc&ZK11UohB=~b3ja?WP|a>IAx6>^k96%HfYu2ulAWu{(>$(*G!e9xo})9SwL%g zJ($_7t3Hauf8G2dXGcYTt*CF&wV4~NE@zsrK=p@2!0%VaanmciYiP`c)$#7sWHYJl zwn~ph@J6$I-UVh;SL?l^j4k36nX?@8!cDYiiBZP63LidNK7k@)c)Uif$bG`e|6xTQ zfE9fm>>nMB&;LO+pBj}FS;u3Bw8!37PMmf!G;bQPF?8Al9YG-Hi}meuxZ6;C>^|#1 zC4RNc6t@L6aMVgW^q&c87OAB`h_KW0yV*^Z)gA^n-UoeOIw3P(0WH|*xyxKWW?v#< z*%M^7rh^j6XMhRTtZQwL?SFwMGhnn9H@$;zm!$dP9|W^tO{}s&i;=y9=P-D>p|AcK3DKPjY5R7W7f8e3*^bSMasl|r*AR}r+Gcv z^sYEA*3J9~{rnt-7w?3hO7Uy^Kb3uVKvP*0@2-j{DC$ZRDI%Y^)QA-6uwbPxU8)f2 z0i@Ru(M6Q1BE6|J>C!?kA`k)Ty+#O~Kw3vKXXZC^=1jZyF6ON1 z3^gbv&`&gKQNf;8L0jPXx<*K4R3L}-n=(_Q^vO$Mdg2q&F2m*^hBzU5|G^2C9am(M zgEg19Qj9QPN!GB0$3zZ_k(n#ANTyGO4$>^x6La_XoDH~K{IwxZj~I7gyXIzSAZjKk zYFdR`6vFexsOCjqbT+*|ckYAF66<<>t5Qz-*YFw4u7n*ti}9S(wfgxa^sPdh^je)+ zSPWchr-%*u@nm;nb4R?`e3_V%@M3_7Hm*iprA|No)odVTk}Kxq}GFaho7ViQrOxUiDtI60>jAR@{uQ9fju z9}ixRE)X#qR`0Ri%d2IcH}d6-$xh=HB6#U%dD5LVtb zAy|hTqAEq@;Fl;X)wF)uiSoiv8{$`PjI%n&Ab4Lz`h1zr`6 zPgohh@S$sH_D94qFTz&lTpp}BeX2**mH4#kivn0S#FT6JD@$z#n|GyYR9NZRPt)+NGs6afsSKNX_ezaMfYW!$@diFNII~Fdzwi+~$6&%DQMs2(KzdbZn z0GfyBx?UZKW`uO!3Grk>PaG06I{O0BV<|Ggi&W(<9v`FdD44ktcyqG~iaWga%&AA; z%1=V40CtxmYJ1^ha8hO<_?GG;ZLeYztCe)cXg;Wsu?;dT)#E6dtU=6}~8*6UR#b~7cu8js-97%mafwf#9D?~}0omS@^R3YLDs{z+v zxGg3}b0m$6rIy6PM)v@&hPPBH%TX8{XTA5fSKm6#Y9^)m$9rC7cOHPo!wecB=u1>$ zi3sk3&fi`jOTBRAr;HccF5kx~wq!9=DD*TiS?HxZ=}MJqlwTb0F%0%!y*9{QTG*u- zeIpyb)_~020S-HcWtW~A75_kP`o%cNUCu5xA$xh-b!dX+c}2xEby6ps2Tw^5%o*K# z+wSI#A@97oI3~XQIaZ^(Y$?ske<-hoFu3Ghr{>E@XO&%kGZdN1c|VORQsym4{pf~z zRQ&%Q6-SvnWV(~vq57K6+&ivI-l)+64tTQMU&K?PR6qI(6!yGv#Iw$w+LrSxNsfPJ=;`ob3#O+=F-eKsi##Q6 z@L;6%_oElD^}q9Aboo5y_o~)+r5{(7kvsPNJYLLICb}mVq+iRB9bx8jG*a~c=CJ(m zbde@IE&$#JtAnz=RY_x5#wT8}Ikif^i&loJj`VXoKIwa!%vpUDy9nN=!U{T0ipcgKy28%OKN7U#U2s-_(Tp z5T1**;dWR%+0oRL_0(oR_n^0{Cp;@DMBT`K;RQJgIWQNduS{E? zxW#ALdCTYYByZn%oCofV#9DuWdk81`7JS97Oj|p_EY3~Ri(u!;U5ahb@mjC8b!`^G zv_$U+T15kONQ=N@2Oy=AV~J4XE)6YS3EY5frN2|@t_a?%cAT!x-p4YYYEK@yM0t3? zn}QCK$E9Ne_$ufn?$PYnkCXAifjNerFC>!HP*h3QuMu+&2rSOD=ejfvAp+m@_2J8BZY=a+gj0F(u9>;2H2eCPJ{3m|8qTrxh!LzSBMu)Ppt z5P7y$Y!li_3Z7%KS3Bds{!)Mr_;3@s?Gtwn^5Lc_z+6KG{Py3lCH~Zj9fS#Hub8hN zFz%tW1R$dOYzFGLeOk@s0P%_z1p%SoDgD6&(#zDRU14#vHr*swJna||)yRU+0mFXr zzWMuwh2CRywa-bg3*-ZkW&J%^zNzR>Ld6acfD4x!_n+M-^qn*@y3|uwyZDnKMACks z@b_*4#WTCE$U?%3#Kb;X45~msSPRNYCxbK_4d6ME5~}@!pYM-5_6p1{Ppw3{Az(<9 zVCkBv(hq?A4%X{bfSyoj=v5^WRjU9i?cgHjgS_{L(y?G*_wfW@(pEO_CrZ#`J0R}+ z>_1po+Tk?dhAJHfUeW!1Xfi9n_~eDcv*H8aBi+K!S zC(uDZz;B-&>Bq#K`FmmbL6Pf)D~E}gK1`wn`nEwDjy? z@I_&^AhBcuu3(sagzOt!(vOKpBYgqgL9|`C@|d`3j;&jjY!jASa<&*cs4{r+RZvA^ zqYeq+)^=1+mlaxBis>w(&$ATE?s^1yi^3+8nDSTIWdJ! z8RlSiH+N-p-{9lJWAji8zPPOQb+y-nm0FrkQrL3KOOaV`${*F1b`ZK~QGlAh)KDg-@Mu4ZBn_3xdGM3o;Q# z^0T(kLVXw5bL&hp=4e7o-8USo9086>bm4pd{jZ{az4Q5qw<)NT8`q>SPKdFkG*n=1 z5ofJ3wn|fxk;Bn|$~%`CX@*L()i7rul}kD+gJ$+LmDCRg5S8Ut`F7sYaA4uOQ?ksy zBI8{LOj7Sgcg<7MrupZ#`l|2mI9p+dgV!YmE=q2-m}v+mFIbN#%|S!v^-~_WY(aY1 z7b4=^C+<$7RuQEln%^?t4taF&oy}g?q|;AeL&=I6<(h>XOX=C8AaxW#%$$a4k6vqo zmlq^xq-!Sq0blJxVEQHvp0*`O)g#$=nvDJHD7d)k@;+acPgNAX^J`;{k68=aYX=M0 zu-REM`5e(QTF|o-2?wnm1rbi&^)0Ri59ac!%P)oNiF++a*IGId=n)7 z)KlNf`jSD%rFJAIAbA?=i87&$C}sqw7w^hlw{fYOL5CI%jGLMV8sr-(aOY@n)M@vF zILmB@-3DrH#UM2LCERKl5w#MPp$%d$ut zI=70rX>VotK;QUTEwuP5=2J_tRgaX(Yx3^~P_(mfqN2PYpFU~Rz z(GXn@Z+}a6mHbs}3g_p}X*E_;}XlLksPl*1msqZx2Uf$6ne9fk4vD>`ICa!2Q zD?0rzcK^U;iQUnnt(i&_oY%sR7{y3YcVDK22bLwfa_8pCbh$0Iti!o>qHoe4QvRDS zv$G>HdeO*Afk>MU|`98YNwX^MV*sz9ppLxQ3PJbH057b;Zba5l6(E4TLA>a1$I~8D`DfG2Fe(nMb z{N`}PE^L&ATn&4IM?Mq|IOS>~-e4UMiAK8xy^y#xOrW zp$m&AV^-^3tX^&jKw3}2io&l|MMvp>S?p-32oS@07(X$;HsBhl{T^O=ZYCP1K0r$L z&u*=R?0%|tuf1YW5>XA~pf7Bf;{v;(povp_4Sd$2d*=f}{5M|~JD77^e`ZC0eC~2e zoEMThxsjX#?TRtX0daS(5XYy&rH0BDkW&Q#D19`+ZI-*J2tze+y|MyNV_W;`(9_hJ z`z2Z@a6FZs;TdU|g^}R!Eh@&=Ysk%6+9cfOf}xjZ(ovrfdz^eIQ{j+T&jv^#<|fxC zHs;Ek{o3Y&hC@ojkYvgOkCkUXollX5rnN@Y#c`TfEL6)cE}|0hZgJ;1P8MyvbudQu znPx71Qd5%PvZ)vk!s^VR3r=%0;cLSe$3ob0tvJ-(LCPh3hp)b+xF}hkr{Fp(b+Nf8 zey-4NEmD>uln5gq zAv^WHm?!#fcHDWNZT$-yj-EyZo~IMT=4;W?Ds-KOa1+?NcEWiw)T(f0G6kQ`+m`Tn z)D@e>>!b-qp4wGZ{=&!7D?UC3g~mE{a|hzq#OD3Zg3r3+y>LT?HJ-~&x+Plk|Feym zXK`3D%BinA|0+symmr^m{*~MWt#+vf6D0E15tkfo8?2@*CWbdCH`EC?z_YyaIa3G< zTr#0ehx42_MN%kJ;+9`N7O*uCcJsxd+D0QRKGcmO^(Z!aC1uTK{pdB&**Cb#GKa?KhWRWsxY- z${P0DKNl&-Aw@y##>b80c2l7(DA{ZU-k>m))n|~(ZkD5x5CUbJKo@bw-R-Rb0xr9I z(xFB07OZsBy}(8)=}EzHamj@*AMI*hpiF{4*>1<2!o<4FTP&t%>}X>I&Eg%5^gMS*&2-J_#NwQ{ zMDBtjJDr+SHQ~>!(NSoy6wTqI%yELH?!A|CR&2#4OQ|_&cj!y!E0oK2cRuy5w46tM zVLR14uguXKj?T>fxZuxGUAm&J@c$kW-ZN{#^?{FB-20FjA^a=D&A!2zCG7%3ifKPIE&#V&lv z@#A|=U04bp?S8_ILh{IEEcK-HAC6UrPX z#&L9c$y##TQGsBxJeR9UEOI%{b_3ySFPiyOLS!N*{Nr=TJd-t*Sil8E{a_W|Ysf_Z1A-6!WT*HP75i^X!8^uHW{v zUUHD!9qfRHYV4?#>y8bK9S*+Xe;7Z0YWGoGHs-9tyJ!wC>;JWYCU-$*gHj zsDkc<3kNQ50l#=IlmqK}lhw5sIk&s!(c-%p$Fz7maDMZON!sV0tf4`{{zOVp#3=5Z znJ=BA#;?x&Y1xs2eofCeS`4F{%)jIy`mNq~t@seJqQ}u+7+={b8A~ne0(Zxq7sCmN zT?0w_rr|o#Bl)FLO3NnckEesT@D9=LN#SDdfahCUSY;(Ih@;S$&RQV_QL2>s0B? zORRJDHr3}0P}9}L4nfzkI;&EJgYLIZh>UZ4qh_vDd~@h2K!Bgo>LbYW(+IRm;k0?0 z5$d|e9blN^Jl51ea4kdz-z9 zOL}=}kBG6(wEN=!Sn9awTnS?#d^vrzA+o-;lA!a+GQDZ^`5)wAQG>fxvUX!%FnPGz z%s2ithf1CGFExwIzET|+y;BT6&ZLWr@ZlssiKRmfxi1@caK>-?z3kCfd-t-a^EZ>n za1BwKidPw<*Wzg$WuU=sP;s$NAA+JZ=HRi=mSwZ9xh%={V z{UC^Qh{07rnSM@Fr)03y{HNXrk5?@PCqYrw-fMhVYp_DJQqai`4vxR`0|Y03`=Pf* z+s+k+eNTAzQe8A4v8H{d(fqfcTaZZJ)>j{cjzd^n^^6vs7g0$Q!CcIqDSlRJsSDbS zj+cCxqk;eR>`ZoDG%kQUYupjeJK&b1oiIz$(Uqcy0hTWDY>?mlP!C5>2DZSHK3ngL z-Du6THmBA3yJ%>zh`6SX-3%r+{q(4UH*)j^I!q)mQ@60oIMYd}*@o`0do8lI#s1eC zSt_fz|ZPfs^qFj?&l(x0a!6;Yjk9_4@e9!0!c<&4E6*wBP%j zR#$VEJCr0?yLB8^U1#T9jKlRkOnYpKH>1ouN)!XVHYt}|q--^va`htk(7dtXRv~ro zhqt0lbpzw~S~t>M8Y@yVYddH$2*O7>yAd)o)1ISDSB0OPLWm;=oYSWeD!AP3tm3sN z!jpsk>aN`B81N!)Acc40z;kZURpURvbIzAmJ0-@RZHC?v-^q4r)P5^F5Mi|@WQV3? zseRoTpDokZ2}-vMp})DqoV`(e@$hplgX`BrS?*a^!YURSa-{Lj1=fJ@gOR(hDbqlK0256y;zWjPaEHJ()R3g0H1|ES7O*exWX$D}0R?gdd#r*4D z{?o>_4Gc_;dcV_|W(>pRto?MKD_dL5>>Q>FM#Z~wrprX8{h5sML}X3<+lE*`LDf?aI#{xgVIz1f;OS2zap6bfM0by z2fPA4dA-Nw%i>G?wXy@Ed1BkzX|9YSPgu@oa?Yn}%B035 zHbXZ)4Khz)KJ%P?nffa`*%7L|3lV9Y^Db3?+|9EOWtGBv!eDuGS$CbPXEcub(=hfx z)GNeuR7|cSs2{se>qsuRb~F{Dpgs?V{kV2`-LZlqPqne(r~YKN>#gdAL12d+i^Gsr)a;Grs7PTx!*Cds{n(_gKd=WtVNaYg+SZ=x2Bl zi+Ft4sLC6KU0OV_)$$vk`A}Gs^lO^9Yd}azve|y}z6Ozk${Lr_v&TEw;sPtSsha0c zaU8kb!}FJR$BQ~I;9=%1+iToJBM|ptg&*hp;JP|yCw9K(RlNO(nZ=DuLVx_!K1-KV zQ2SdoiA*xuwUL?C+9FET%PX?qFdG1SeLw7!giYm8w_U3@xd63EY+1_Pqs$?L<)Q$NXPeH`A)x(!WD3VWL0wd{d| zpC#;M&j?ZdzT~3(k+qx|eK`wa&!UVA5>3o}+U{zUt;&P9umh3qC%k@Gdcn zgG*A9CBGlD)YqzSR=coJP3dd;p^7@WbSupt3d}NZ`D_GKIj9s@EQOCl)(qSGSJtdc z5l(|Z&XDLHBsqgT)pNCGKV6%0w$gB9#JrAc&u)Rm*#yZg;jGG?v!KG$4Sa#}~>)_1Q7^jvvXJ?N0KWh_6{ zdzmusYwzV!WA+VP#o;`p#ficpd;NTijxF#Bvkr#2T-_E}X87F_2SycFG)_w=N5$IS z^TUo0@OIDjm8;+2-)4Df?9)vBdeEiPYq9S9ZbSDNv8tbzp2e8gBx+T*IiY)({_3_@ zJL^IO-^RBhEhosi=ZuE;9{G8adzJlpnwT^C3#4zEoW<=y;-EqjV<;_n)Y@K))z=9$ z2;}Npcg!Odr_Dh`mw&q;bwxWol*wNzV2esTc|B1Y8Z1-rf!N9DVNH>ll&~QYn=%*Z zGT?-A)WLkxqEZ+s6SJ*+BNzJ7(-$0ij=Rye6@hX1H4Y!HWw_rYC{0UIn$T9Jw5WUA zFY~y3GUSZSF0Py5Tl0tHzBZ6thQa=)xa@%xVPkH?9fpm5$rQyh^Cn4!rxmT-SO3?T*RL{=|Y| z5CbeVrN=;s3131k<=Y|gW%c5?G}wHZd@$$DX%|&OAT0mS^`hM!-y_WF?>1$=Mp>L% z089Ix?$1BZPOkERvl?CPgeMqRq(XhkFhK*C>Acbhu63e2qMW|)L;9K?6Tb$a_n5s4KZbH!GfAsDb%pdWGmAxe@G#6BAW8|6rS=3C`>cpm3V4I9D| zX!2nBgp5+6VO<7oi2Bg@I1kfhh(WwgL=Mv006rIQH(yL=qQUPEZ=dY9a`NBnXL(hr zC#q~z&zcf*H_4DfBH1sD=+l|T9*QP*C8Y*`OJzvEzDjH_aL{ieRmuLHnQm1%RLhe& zfQ;qm72j3R)wxDZaICm&Z81blZ}_NNTS&yZMqLZ23O9t)fM(#k#73@xX15)g=b1PB zX-_UM84kbPIlQ^j!MErD5^T47ymmG%S9frgyR7Zbt;?VJT{8PqZer>J8z;{Da5&HO zvZkwO&o=u!0nKN8>QSH-Z+(ZH4-d<`ks|Z(DqLyyw(euZTA$fnvRchdog2PXl=laW zmDADL#k+2-_o6uOC9^e2Sbx-yW+PME#djf~NP$WvCI-U#pV54ld#x6o*`VOEz2y#` z#r@}5xF7z%ZYNWfG)Hf5-QaZ8yz>Sn*WWJ6;*1@1t1p^*l$TpzDOcHKYB-X^!4sAv z6d(=SqCS@O>3-K_eo&#bo9Of4|M~o?M>zRbv^l&{a>vAyca?w?#tkW#-|-VmObII& zzR~siII;NhruM4(&**$8%|`n!zZH53OmGPs;k5>eo*PnLve6>Mf(&X%_nV>ejwF`s z9k$E&y1{=?FHyO3D3sbAHUlW402JK>6HXgaIHaESCI&Vq7#**Fmc+yC26%e9>iH%9 z+EbI(UZ6nd@f7EN-ZAjn;<&opR1OC@GZzmwVh22o4b$1Bq6hC8*~8x3{R}uZ=`>G~ zs*wBT$h`{zD{r}D5<*>|O!kDS1EBya)m!n@A$z@}0QM_)F955bV~%nIC5Ny!kg_*# zd%LiEB~i*JVIvaGL5LKvP<4)y?3k{3b{1Ow*R#cuDM;>Yqtm=PY-TTm`vXvoeFH>d;8a3SJA%y{O!WKgx0*_4a(Qx91}4H zrg7FT_?>@Jbn8@$?r#xfZ9a&<5MaD^toBHey%VJzEi;K?M%r`%?*x;tCpv4l1 zhy@RTXD@d|@0%g%8^m6gnyXPq{tW>MQ2r^(r>G#ZeT*pb=M$j6H?7{IMeXqAr|5tE4hK3Cw-u zfAJP2Zp^bcPm!J(Y0U?CMz3w1lh~)=zZc#U#A-dGW*;NTO;V5r8qFYWa}b^vu5^Ie z&9;7{{~HaFAmb;z+*5VzyJ$$5{q0Uf3DBEP_#nxIv~m-%s=XQw-dgd)Az$^79e5bM ziQz3@NR)O40!a)ByHgx6?$<-B#C8t^GEQM1xYzZ>wxP(Rt13TV@7F_3nn1Doc*~!W zfY^u!wC{4q99Us*6(%b3WC=aZK3U#JiTxfbHV~4!?`sO_;s?7il-Q1D!DT7=Q(V9r zoZt-0S?cZ#Afc>K2nclynI=uX&phcu`Y>n{6uMH>Lt@7~0H}MQokqYjl3e$>*uU^D z1GpP}1TS3MBg@;A69`9vZaAMLod4FZ1z5q}WzW}sBDYV&>k1(HS@~{p~oiF1N zABl;GdN3Ei+plE@wTJ!UZ2`=iQpoMSZcQSe|MxsNpdbot3aFal9~hENQ6VQRg-10 zV%PzDLOO)l+WE54w3S5Y4AFqtNJxBp8tVr{ezj{Q#7u;Tn)2TBAb_jZF`_*je0lE5 zzEJ;r;cZH68Nr4P{zc-j6VQ-hF?z5$43q~{*=72+kqC<5AcEyHBu|=(^hXk;Q~;Uj zs`gj=Fi0m6Q&uw#QQ-X_B)0!07w-n*(G*i4uouV>_XIzXs_;igQ4+}etB@{QrHP7l zWKNJYHA5az{S26(B=!4&g}VR__AREraRA;e<8^S8rGPV0H!5W6ZjnsWuRsdtf9d1; z7eD`GbwdLXS?Q;2Mgky|Rprt`Z;44htnaE$;%-5NcqMIZh+(prMSCKa8?L}fumve* zzLCkVo-IZB#S+K)6?u6U5}Q9-@!feqVTs)eHEAJ59U#d&koXS=+Q9!di&k}#rI9o1 z(r}932$o=dL&d3INxzD!kmgwEwHP)ZvRn%5CO*KStFtTq z=6%vC0%kF^f;egV1L2VHwFAl{)a=B^N#f`vr;5-*@7o)1>M&yoH%7z}3Q+YD*{ebvvossTrMm46l z`e@G?{jeGBDFea(_5F4GZ{Fd)j*~8a*oB=~wJxUdH%NaE zo^y21|MsUa~?J%)n zpyQjRq@*%fQj%I3W^ZO`V~Tvg$-GfLTGF7T5QaZwu1;E*+Ri&O%K=lJ^qI=Qj;?%l(` z88_$?bEJzxI#9Lo#pwL>^pYuFq%jf~CGw2}lTt^wboCvrk2el0BF2+Hd--r2b{ep+8EbZ>0JgdVuOP zV)OP(H=avqS^0c~AWPU|LfJ=YHw)h;&YX9>Fq9+C>52wdXkF4pZV_Bqgq*HTSh%1$=d)}+@rI+Z_ zCnZ=BhutBaJa_uXEYGKMbyAd>1u5(}hbbLo8SA3ZlNj$8HVb-j)F7!bVe>ri#+QP3 z)Z$YM-nJ54PuvYwKY49>(V_FbKsHlcocXC`%%U{&QAb#)qm_Ne?hS5%_wOQZv^?a1 z9T`0&4nxKM_MDm;<9>6@4oT;icth6P?C-7*U~&l&)jabQf_|zFAL7mA*Q z_Lg%;glW1-Wrank&8Gp6-U|qt;x=G6_uWQ$iKoVw?}n0dgzj*BTa&FlspNetsTHi zP#x})qbq#7EpUy^*ZLc%8kf@7?&~!@Kf`UxH;--x__y7}?Du^`?bt>P^Sc{HaQpfT zNfqV$k!YEc_hs=}{WT=%l^LI)ZunZIrhmm=CU?SI4WN_|{Yt%$b#f!!fDrNm&j8mI ztLu5()pL6N2WH6y2-pHfJ}x-i@w{#q(EDNJTb%>{86o9E)JU9Hfn3sK@9#b!W4}ZwdN@hyhIXzH0C(4>ID@^P)YEo zv8URndwl)4Y=4(an#%a~&ZiPi>{zF+`;c2%H`Lx*HtT$v{Jd{CZCv`4beM201n&dL zh`U6-bge|V^k7uOhM|%~*ze=4lS8F|y$(i*f5hx7hlyuF4(89Q9K5PSUGLQ2n#QII zP-=O-jroJ??BUtHGgeP=@5od|4hC1k``1NU2wSjP#2(?!V!aRLkQ=1dCTs}i{B+|x zlaXL)i0iu_u|G5(KmIKBS<*D*l`_44rq0644$~;gC?z_DaJ=Bha-eqb8u%1km~kzm z%7kmoZ(T<5erMZSJMaA7eD-{3-feXc^-3ls=S-_itMpaYAx$d`UPs=nanA~o3a*Md zEB?X2LF`rHRTk%v6PyFN1ESTVK^dM0q#>lYNXJOmc<`-s`tE-HWT|a|WwpzL%X?&% zJhGmd`XK8z@e6q^g)x~L*_Cvo+~_BKy#CscL?Iig_|}$IH5Q*OS%>omg$johB>Pw_ zY_y4O(KqfEzCLt||G=}zbAhNBSk0P>KYR#Pnovq8)-BL2_R>5p$Jb?0W>7PaP>kpy z(nS=#-6WrSTwCYFzKXx1a!|it?f%)lb)Rze;|br1%8C5J(W?Fk6(noUdGgY-IHP7*SSKn{PD}l7n(1yIngf^U(!L* zpi&Sf=m4Yy3C_APz%#&_Wt;WUOxmoxD>`l{UX+I+mb(jcaiVLYTm0!$?N88xQj4;? zC4-eF&_%6bZL!Mx&|~d|r|Mc$rC+qU3%Cp6+A|1WTOC^rz9>F^8$&2R^! z3gy7#f&8qQa@sM@4cLa&hWonZ;p`#ip~7LYS!}m#e5s}M=^K0eB780UQ*uf{E1^Ik zVu4D5#%E>Ez6+@fO+5n%UlS~LvUBm?Fj{MYk1fDvqP`1tI={6}SkvT(^9MtdCQ|F- zJYJpRA9>thq75$%c{YYVH@j8ZKNs1`pv12fx5U{iUcX+?)qwAg*M&%IPpPptE3OLW zZ}kX;R}oAxd|r}CvC}u!53!Hh;ucpEPu8!{7axd^`ylekb7AWn`;PtgW%I5Ht9b=h zDw-eqD|8_=UUXx0X0#NnIE>6|Ls)p%>af`H?C?GW1iY}pscGdia2(@ZpH)8ky6~Q) zMb@y-@Qz_`i){=2ENl5Ut@q`8z3w6to|P6ZY8WpKWNboQ2`%r%5xK$eT@>dNI|O^v z$e-NYQDBqXj5imw->GNbb6zs<7H^QSMK%Aha~mS(+3_KgJ@LBY z9do*!eI}OoqPxPE4U+Q2G?{NbO z9?c!IrG;83tJ_!E?_@gL(RlXl3_bs4K9}aX>NjO&?QJ{fv(@NF{w-%M(_4N``K+p} z;kT!ta}{PsN6T9;X5ar(1X*H77;e%a7x z!ngxxK4)HoFK<1qoBOCZ-2<&Va~ay;8`Uj4-3x7@+SF;_G~#8CRx;3uDaqe!=p+F4h_7lHIk* zMyDXJrSYjTxNx0O-R6vZOF_;%&iWH?1ZWpYG=a&AA^^KP0d(HZFTGdJ76Y*{}Pu zC9J2_aB@u0Bwj?oaO0>Ux?ZDR>quj1;{wjMH7_J%W*%w>0QIAvPyQDG{#`3>}=xRz7Jg%Y8rQgdTG+x+Ay%J%h> z_y+;s%TGkyKdP%ym4k9h`(6&=G~Y7OnnzDvyw*JW^!D5}19S6*lNi~7#3Yc>yRa3) zJ(c&a)+i`Nn9qv|Ul=)MKiYAoQe8(!(RKtao^WzXU2ra1p(M(fY95SxZWF}C9$)s) ziSypgZ^k@RyTsnVM)k^KzeOJid0&}61)C`-pfCaL>nIqgq$rp`3l;bkLnZswmPUPm zg8s7~4Fx605(VSmV-$hUtDi97_iE0+KGDMiQLX|1A_RV2Q_=o28V8b!{+~9Q8Sov- zLp4b-82D5(hMAh$Ia=5|wYR?f26SLM$Z9#Fpb*nv{i1?Z>9&FOM=YN_b$Y4*5i+*7 zWivFfH!@{&wRHeSqo9bm3IR=9Qzt`eS6dr9MdW3XEWNbhC3ZbY-=3r2W?-|5-=M)X^Ab>EL8(Z%2K#uAz~=vyTUuBvSl~ z&OdtrLW|*uu>WG37|xy540V8yKA%C3G;xq&|q{`Cp8QO!7f9?Zs|ph%#A zr5-+UMO~l5u75H|)w(mIJI>FljZk}8rh#AzD3iXgf&+FL8)5NLt$Z{r%P55t%tz14 zgm^C-ZJ}Q=6)o&|*}E0jvl3UsJdW}{0T$#RY<6mHBwEZ1A$~8JxV(V%j3Q}s=QD00ipznG~jq(ly%MDlJEvbrp;LY zy{E$JHziO|G5+a~?>dnzHAkFRb-}&g1AWgxCC>($!cEZLf!o{p=;AEC@Uq+^j^%mZ z{%v~86jM!&-k>F7p(DE8{x&(me|GnKpa0#O=R`$|a9a;3twX{xpV1uH;M@KwgAU9g zoc0imr%>x($z;hDk)|+q4ILFbmKf9-L(8#3${F$t{(mp~i!RsnpEu8c;5UDbyu22w zt)VJxjQf=1S~Wffh!wr*pU8YgTk0Up>yX85Y=b?dr_9s)wl!x2 z(ncUW>^A%-ZfN7j+ErKBe2fr!OAIQ+`}?BiSBn;iLuGz5npz3FV5VA&Fo~GHVY7x7 z8hgXJGs#Rc;vrF5f%0aUh;!mP%U_u$4lwO_D-kAzv{{pc=92?5IvP$ep+bImaF$AY zK!DUlyorecSNHluj+;Eb?a$8z5s!{-CKxo{{EctdO{AVTn@C6I_#=47-*_H%G$A$44>})l}-UD zzU_(1<_Sn-nt$laL*%W~WSCAzPe0LcR69G|iZLJx*N#7?x6H!bOikJn#X`${6f^0z z9Z=qhH1kh#IM02>iS+=O0MbB{7>NfQHSHLnh;ifw@cn>u+LZlfIwksTbS`%D0KpOs}7S&6E!-W+^V zJKtlR9Y2LM<@e;@Eoyz7o3ULn*-`$FkUG~e0rjcmxVIW8`~h)4msK7VXbV}hw2nB* zDO9k+jkrU=N~IBm_BX0iJCp!oPigb4GU&JLNKoG1)_yZc4B}v zQ{xN9lee-6Z_Z%;B=EPD=l{e{PTzfBu&p}RAZr!YgNEbrvJ5P`2H)lkh7YuVT@P_3 zA7bb>RKI1^SA_Z-=6yhxiHL~KimG`zawT&rz&q#>54mZ&0~jm~xd;*sTyFiI@TZn9 z8nuK$8A_rFKGHznOQvtvKqIzcQUet5G)pj-p}n#yGzw7&iGOP$(Vw6H5KKXUg`Oq9 ziF4^p@|5yV3;$Q&4<*0`UJ_B^BH2J?4vhMn^W)BI^o*SCf%Fa0^am=E5ted>=;80# zYS2BPF%WLwb~%8Rca_QM|4JZjK)h=X2TP2R#Cskem7OKmqugvmXdvDsoGwlS#4BJa zG*wwBFO3DNsAsqt#skQ_N#?7XIfGH$zsdQ75&#A6dhSv)vLT3lP7*uV%4Y?7-+E~;XQs#&B9UR z(m%cKj2m&hVD(MlFFvHL4gj*Z zS!3Lb1VrEg8fonQqX_H7<_t@z{u|hp6<`YPd*HW_cnx}VZJthxwQ#^eVg22gv|jm= zAB+aqkhak_g?5Syk=_WOASd)~pY+lj6aEXiapD1y_jCCosE0I=i}B_StaJLb3XTS7*9~ldx10j?nyJ_CQbL#`iEaU>-vXl-fzspTo(xYx90R08Z3R}RgL`K zcx1#qVNs*o6p9Ug&LCmXAMp)IEm1N0v8$(^twHc0AP@r>rV4v%!1Y8462>LMaZeUc zj)OI-*+fVS^e6NGs}EDjVEdE!LS}Ew7&_J9o|GlbspkB?&hezqvE?x_SxDma5f7ub z0C-&F>}|nJ*#z6^=$+QK}-cFB)Em1tf-aA}?p4Kl_f5fzlb(5{n| zBbJZ0R7y4@-Mv0Ecqr_$fj#Qy(nnz}iMdh<88dYS6LHm)n@oP4Ft3G&3Ug$l zMcqY6!CdzU)?=Imp?8wa`^}ZD1(HFor$jZ0n!|Hir(0}eCC)KVSoI+tx7p{r<&KtZ znHd=$;?Tc1G)>YvB$&%+eOd~+RoB%sMU!&>1!76ymhPtcK*cfTo@@VXPzJQPieL@G zoO(x&q;d_s-#joxEEslBJQ{XixT_{dyD=y7K|Hx>;h1=Ev&kV@IVO@S?`AwFiQK0= zpq>O=IZN)=J3_)o_Mi3@BBT93d`);bLC?<$S!{RgRYdX`zex2<0>|i6AJ#1%dE26U zX2%lK>hrS7NRwUYrQ9bG;T-6xEmOx^@lw%k8V_stX@B19T|WC|D_M9dW%I4Y^X)iJ zdDE79-f6ni9K%mR?7~92@=@8-yq_^R{9z~0f;!5lLUEze;^@{exP|w-N5PfqU2W8} z3dP+q_g?dVnoKFVBZP_Pgil%pk%pX3*v%wl>b{xr+`QFa`j|I(a`?c1u{}|rf1Isj zBE>ycL<|;OFpU^sb5GY=9OtW;kGTU~*u8LEM<`L*FtK|zLO|?Kt-C8sl|~@`kwTXZ zFTK7RZ;TeiPkLV5^5z(rXzD7sq;jOBay?==ZV%vfhE6M2$${Of)kJgk(-HhDsUn22 zA`iN3Fn*gQ-+G2`nDh-YqJG=W8H!*IUB_$!NMJNLUEYq~=>Hn5Ukds2i|a(yOG#Ac z9CQ1P*^g~)l_fp>87?ei$h>B9Rr6J`eJF}UFD3PkzaQnGKDPa^9o{%|Li5On#ysOR zu3~<1FJwF0)mH`&yJvM|oR9E(_u26lYya_Bjh;&2RNn)Zc@m!BjxP<_qZ|f^=FBF8 z$Xg>c9X5i)0oXy)(;O^3E6$dB6Rs@!RkSPt%a|Y%z=&FiQiSBIe{u2MEEMPBa2uI; zZ4!>H_JvfNTH#v`)S!>(aQ~iEO)p^>D+e_O3Xiams7UZ)%~EL1qUXoeQja6Ap9YWG=Fop*{zp zv%`C9ZA0dRh=ctYlGuIFa(y|ZYB3W+GGZ!ETsEu5|25|zPxAo?uJcrLHCBVdImfI+ z$bva(Tss?|VUUfM0`fZi?OJryR*Y?QsM!VW%w^?R&)Q&F?WEVvI~N@vQ>XK!t_hFxFA-2t6wc3q;=vjXi^%Vbm;+C%fo# zomzjWuTg#f=(vkb+6&1V{V(Hu&#y0=Ls+*iwJS3-`mJ%_Pafr@4wEz$%Y2IWH&TDtjiViv4_u% zGc9mWh2UC$P>F&2zXN{d^;CrLm?iycdJb7M;8`&G=Qqmc`h zWcy?j6z?{Fd}J~=^ldgFHd&tLCjSr5pX4T%+V`7Qu=%zZ5Sx1a9{j&8iQ(%aNA0R)u>%zfo&_~e9_W73 z-%+DFzfYTeY22xHIilJTd41~+i-y7Og`s#m$xLxHZGLnl!R9!L)xM^U^fVtU6Fv_s zv$TuCMn&K<*8Qr4&4z>-?jg3KhaLQfmDdHQFlgo1@uc+({6a~^Y?RgNdhO=zm=>!i z(iT{V0$FPLZ>+GDj3T;RUs%3ZxmLvsVdv25aWWP?4kq5be^E_l;aR`O3DZkwx)8Dd zG!@iKX|q}-w9-A&I+OsHn-Jq(&o~t#r>98JET6ll)kGFMNX(;Odx24Bqj-6rBW}Q) zI>yH5^Q)--AA^gA9*&*e4fDx$TQ?Gkq6I5-$Y9%lee7_=k} zqvKdv+5X3Hf%>Mxx84fjjPr={^#UlQYGCTnMVNvI&k<35WIbls^6G6U3q$dN5a-nQ zQnUzLswA3x{*6eGOiTo`c3_p0=HFPPFaJ%`yz1xWUkM+0Z->4x+m6Z!ajgT4tB}Y?R_{hWA_L zkvY2snHhZ+V+eC75JvF%4lRF>FZ7w7<2L;qc-ztgX6m+^XS~70Rpt%Xq9}Hfy;YOv ztRUF!)Vbk|ZKvrH=CknBV0Y4GY5hnUT4hI{#I{vEh_z9o~(2P8ROe z%F7WK7E9OO-hMF~cnvfFG2mLp0HIeVCTPdnd`)c}%%MCvOz^p>BAvW4qbV1oc)7?a zrw;n(qZ|42=FduA%svHUY~!~3*;!GN6pJiVbR$h?fT15+a6&ZC+YNLdGQt%~J5BdT ztof7a01H_$G-X$ovZ<}#BUBnLVxV0>ZmwOhuPs~e{Z%AxZ%taT*wEDNti$-TZRXBv zvF?mrn#bIT6@0IzDAW8Z^PD1$+VKFeJ@0!}iu&gHc4z!|{PyEM2C#q?m-^%tZxPt` zI2-+A#mz_8F-Nw zM7J93g=Ny4JY{(BnwZrJ+SnH??{li)lC>T=USTcY9!}q~YDshRdfUmtn(4;4 zvud^Mtz4blv`9uZkgh2F(LCRQ|J;2uEefY;CGks}PUjE-k#%%4IE7I1nDJX3J@K#8 z)z2adv@7IZ-C+h@J-J3yv}dXg-q{hApJAHM{ZYeNvX`>|Gz7ZAGa^(F&bWNYXFJZ4 zuUTAK&ZM44x6l!FP)NI`CjHBKw4I~b$@Ww9+8C%_5-7^!F6Ob-q*f&uCDyk zD;h?ide`$E805eU&jR80gG{T*v?|d{m40O+vk_6fWjz)h&P1TEr!)@4qxF~F;=B7f z`Zgr9dE@ zBUS0;-6PIhJvO~0rYSCx^@mRe8k6a~D7_wuomoWMOc2Xq`tZ8dlRKN}HtEgFnuQKQ zy~oOC7T$ia?<_I=*Z{sTZg7|B)Uxe~gxc5i5jDJgS5#B++7A9z zd9ef@)Csk3GH%Hvo775coz5LF?Qei;GODDxj*1|;$Qu2hE)tWM1CRo>y%!l@NdorQ zb)D7CYjQP}PMa=B^h2r`o;1BY==}cJMWp<|nFdePTf`kvzt>a82n?_QLf##oM(t*!7b zRN_8jl^BmZJzl8LaVuD1I@K*t>bjwIC)U&AM=zJlW?l)k3F3U)FKQgK#^rI5q#0Vo zrV#Jo$;UDUF3;5&t_j3ou74oN{J`3lbji`$Y{oSiA0l=!O1taSWPV1S#`PH&f=|Ak zI0;*$FpRe|fDN`9_jeQI*H=0Gn5|gY_)sjLBqS5i-MF$iVX_~qbZ)6w$Bdg~9H$$7XnfeeDPRjkL$&a#hyu z0bUmCy-w1DR@({1uk2!edvWTmpI+Qk-#``WPS9YD?c83-8fxvPA2Vs0b(@DZekq6; z6q+|ez3$Z-l_cE0+jJRiIgoYAFoXv&t8DZ}%^gvw>UeXH`~2WDX-)Z&?P4c{Urtpu zr^2g{gq7po)_G|107J?ugTI~|>#$i%R_Nt-?p*!L(Gtts|FIgsLW*DJO#;QY;O4Sr zZO!m@VkN@Wr!{@Pr|J>jlX^#}q+pT8KBX^k)@UH6au(DT8^3uYYb@C@9dm#2vQ(=U z?>g_~$mV=UrSN9kFm3M&x9+gbv}xUXGKc-!sZZO}Z(FqU-c;(s$7Q%R+AhU(jG%r0 zN*uY)EQ#4QJRj4vWgVa>W8yg8DY&!yUV}tV9R zM6r{GkHSeM-jeH)*FmP^_p_5kx&oxv61JB=+}(9D;38G7Z#F@k=o!Gy0)qR`ZcLl?mO+GQ%^a&4Z&Gba$$GE)GpkG8#k$AJ4c1DY) zHfOkad7s3Y2YDHgJ4%`bx-17fb8!$Oo+7% z^M{3RyG5t_mJip-3ub$Y+Txj>M6(%5*8x{4Bo6%#*UBCl?6y>R%a-|BepadbG`u}O z&!GKD$E%=uzJ#%Jp++fsd?C4MQNVKO+t(6j425*Uk%k}sXZuIQf(JRfS)V_h80vbj zon^t5Dhj3DarMUX0{0s&^o^f+iJv?ci@gZtp9n-X7n$l{H#ad^>9FlDow0!)lr0X; zPvgsELf7B!__U?6dsn^hlYzv13({mWTr*KOfQ_wg^uM>y!R&sDI)bOPO+BS- zA&nN1(xu1P>vNI-q;}WrrbJ~oTy*R7M`&iQfexsJ^`F&4412Ov0XSeKYeU#NMF`i`F;1y@!UppD4WOf9UDqc;r(O}JLp)M>1$7p-H%Rt z4b5p))8_y`1ahW+bpJ4WHJGP90A-mnHVds#TVgY0omj@{wS|WuteoRFm`=}+WKML$ zJjgtjKb&SP9gMWs0wG7q$`_CBac3^ryv(%CscXwlD|l~FVZ*hPm^DMI9ONQ0eu&tl zk3m!wPI~UPn{#>eOqMuXj!cfrfqq|~OKg%jpoiC1*}3T(0QY_%$%kNe4$Eor@vL3{ zhj`%lZyCqn^0|k(s)FXVP8a_^b{a0fB~7ZIA^s|?JFTK9vV-AM;|g3R5fQU$4-V^c zu)(Y?2+J16^O~IO$8kAoEO+PeD^W2h++C_7Z)$4JXw=`G zzI3Wb`0F_BWOBjnmM7j#3$Zus6P}70bw(F1p7+YEXxDl6)c4kQtrPv;`yWz|VNqzg zzC4!R_O7x!S2?LKj-fAW;-31pM^2&EbYa}O)Jrjn8M3Qkw^LQ`h-RS^zbsduPO8=6 z$;p=VkIyt+-dL&o*a#$wK3fZ_uHiKvn+UGFlyn-zA1BSKe6@nN#9P1;s_#~y*|lw) zazy+(5XV{IqZ8a~&rL@5EzW1t;}eSAA-@W)uZZRxe;2LuAtKgu4bpNZj@&ix{qxUU zixXeP5PY-!_zL;s#=6@}O}jeuJ4SGDZ25`eBCbBU@8(b3|16v1SN@BkrAX|7L-CPwcAZ+dKDd#>#3$rjC46 z)7_n+{Jgx>?d@Pr^axRR9a{LLcYY+3mg>I04u$j^SN+YJt%t&!=T_tMPwt)c7%*xS z#3mtJcL-14f3LKiXka?r3EDCPXUe@N@ByqUZ=~C^(?gf0`g2?;Sc-Ju>Vc(y3 zpk;W#BXH8+OtQYSa>Kb{uE%5kBZ18E!M>!)`S$23^;pV>>%X$k5=BH;66$CtD2@T* zMiX0JK!wd>E}g2UV^SZ8cH**&(7q*2wwZ3Ge|g&EExoperD*4rhsS+F#!b6bf1Z`- zwz%RFe&OR)?AF9JS#SR==qj{gpxiQM_>2RQ_P9((9ceosxE%4(=9#%n5u>Mn+#^t4 z=oR|juoGt52|hg}87*p_0<7%+m^LI&)rR9Mqu}b$HNBl$WIqXH>g2|h{qOV*Q!#Vo zI`i93ux_NB3|HFRwbe?>(v=FWE-xJvLAcg3*}aY#r#MVB*OpHkV6DUwQEIS$WdR=( zx>3F9YUyV4!f9=62E*1fV}yCn7CyhTDmKvIoA^xUag&?|7Kpoy0LV`nOQsh+1ngGr zM?2i83sk8$A}*gfVcv60x75muW3$mCPCiV%vCn$tT}>h=b=q9AA!y#2U|&zDrOvkD z`nZ-DDt2juNOWk~F?2o^o6^_wWb{1FPWIHP)fpNaehmar1RMwcU0pZ&&?0t1hIFgE zOSFLV(xty*QkB8%eM|V}3p-xHxi`aHPHhH0+S2F|=va+(=O^Mz?Af%W0fXm`LBQFj z4U8wrs_H%$4}SbO>iJ5?U7jcuVV}KYfNvQ#>YkOc15~t@6_cxuECQC z;kbH0Af$g*>9gkKtZ5_r?$WDT%8Yd^)^1vhK_gt4t$;ZSpE2AnS@Ej|Qw7wHB7TUO zon5!7Sd&Y*?`(Bvmw*et0_u}k=<+ViaDe5Q^Vxe#Q^B{e<(m4M#x*D#P_nAlOL^rw zlQ!1IHSRT7o&ZVW1ae(PtOJq0q=nEr-!Jcu67M_bNA52@4p|lxF|ECKX|u^Bj%ZKsSxB}3h2)2K3S>u@K*{d2XOyKNue4>P7? zf|^o(;a>r+WW!;Z zIA98*Z-XV4iZ=uaV+W&^v0}G%>L1p%h!vXRHpwAw&WgfkENcVS7Dk@Qq+x<&d_+`9 z`K^{UxTh8~<+{gZ0u=^Oz6H_B1Skx&0G@s!fQT$eL42#;Wp|vJeasS2#Li0{CNMaz z&VkFLV0^bzcHsPg){8QtjqT${mtjV73j;1~>%<f8b777pIz{|WR21Hj@p1tBoMFd zWJD-N#$bslIdBo*9Qda!0V>As8;KAMka5MgyGpF(G%atiK=7?;){0O8A)5g=Mvh!6 zJ@|%8AtYIZe*NyDroh+c`Oh&rpz@`F_@=2DzWYlv&P%{U3;AUfvwl}ug>_;~KF`>U zhxT|Ha2doDmsKS!`FrK)hon%C=uB|il=q5GD6y@L(%6h&;M~KLa9?Y;IA7Ag`=D3k z)UPVms|#WP>koLQT0GqshYwi|th5=s51(>udP5=1W^>wybCOv#`*HeRAfD1Iz68tP zR_%|id2C-as@TEu+sB4xQA|+_b%NXjNzE3zFnzc!d}U8|ovo(4?nQfW1gLXpsz|=7 znDnL1$RW94nH|N%_pV@u6vE+?d0#A0dPSPx;vB(%t@t>GbD>6|6+#Ol`6~)2&?^?)lN){79z!)Y!$3nvI@!Bl=|X zG4~$+dhY)uey%(wbunxSR?Wa_rUT4Rx z$KjEYPR+hxui_HpR(wXSvW!cgQ=sl|{>nyWpB&;&Tw^^uK4tfAaN>^p-;3S|TE9n-;_K3J!1!+BYV6c$LcNQeHdq9w7$QskGn^K&Xx z0SXCC2JaI+^jxj^N%R~VEtmy>pwN4&jo1$1+ zZnayN>#p;cGeVpixDnjuJ>hmE``0JTvO9%4xX(|=omYwn2cM4>6Sb@^?~6yXzH51b zyY}E8V|#$4Zi>`E0{5PJ?P^|6|46{P(~pfRQ<(M|pW*9i$D<@Tb>(;$a6 zhsU~)X)4I~V3mT^JaJmiWoz0N3V^V!t8zcRJGLvYhyl`fKOS;oZCVaW($sT%5y_~l z{Y5GEL8$o7lTmML8ZN-%3=S7~nbf)i=N%THt~Wx4(oMo@ILA<&#oqC-rp$FGyrh;P z$tg|8dn{8GA$u#1`$*Ug{=>s?uVQ;IbT0!E$F-8hjg(h`V_#Wb?w^+T-cYjW8dHrFn7;30D0w>#F$b<$-$MlXqi|i$4=7E7LD0n7qxVFEcVSWRqw^ z4>ab)^#;zZEXUGnGO$!lC#%^_fo##4n^4+TC`jQh3E$hl)eE|TsWq>GrZg1GxH)ne z)+3a}BY-?<{H$a4)Qm!c5Mu%JYT|WBPb{arklwW5$I}hc>|ycVJ~^^b^qzs{`{u4OI*OR&!%H3fy)h2J(d=@~F21V-|j;5}T z&VBG<$k66zbl>N;abNOpvvM4NB-ooj!)4#e3lKf5E~*pR-S)pg6lZ(UiWY4}6{#yW z`EjSQ4vCB}(M*V@bH}OtHZD3$S9(J-1v3L`7WaH|wEUj{H|#PYhn+h_^YPXmlwT_e zGz?VXc0+kXunlKXV{hMfQIzwUGvCv#i1~RspR0){7vF{_+&h;!Q%=@i@}}t%du+ye z!!~Q;PWzt}9B@+n(C$hbpz3Z=5k%X((?z}J)zeeB<731oZ!N0mCDbg*9%&&8K2V3Zn z?uiESAIbe6jlR@~EY9jWzpy7n%EE7$`gWyTbS11!2?#*RQlgw+hI; zn{eFa;RN48i+E2oU7)3Q@A#tb{i8QCCqCyTaG96h@79iHE@d^>_J<2IJdTR`YlkdX z7Ae|JsYGSevOHOf8xI4!5)W)^oreolBuRONv^E>_tDY3PKdn86{LxMQc4C0TB9Ck~ z(Ua^uR{(==;bGW~BeV#Kh-^kCqL|citUuFNQD|CONoW*lGp>yk#_WPva;Y3BmrHCX zT(nAIndi^z04uKA=vfn+FQ=dorJk?Z89!ug3fv^AX3E{kwb8!Gq>ZrXGL7~9mB9$} zz`P1lGNB<9v5*Kvs;uAfjF!J^4LwJkN0jkaoO>~Fajj9T#Y~#UqFaj~H`A^eXLZ*h+RIk~_lHNx{D(LG zSE z1iFyyN-FggIYhkya+Fc)-6H4yWzBx^?7v+6u_REle<2V`j)^o-3v^`D<9Wlw zVp)Lu@bIuO10Sc!!Ei)stQ$7r4Xh2N_&CxV80+;+QOt2N|9E8iDWcR%S42w`h5o+v zlc3i8$-9SFywgnPa>4l<@3?>(X)bixCrH#yrM~h^qIN$4>td5LBjNb3(BWmhN8pQ(+cX+c+5Zi*xz%VE_|EHYPEs*-sRasP(p5GX5! z`8?`EdeI~G`A;lPS6H6w-XLc~+TtIv$O2fzgyP6?kOpeeTrtnfF0R=`<9azhl6d_Q zRvY%!I~DJH_>hh`ZJ&R};RCEhv0a}TLUeye=zlgrzSY1L|J*JI(QnMYehk1i4wkP1 zRzJ9?!>2#(AE|Giq}{&t)K^^bxq?#ffHfxbS12F=N<0oy=H(_(T?|0E_meB0h7QX}JNzS*XID_p zFv?Dm2AcddxXwSJ6n3Bd6^a3HBouktZ*vWaD`6SG;T;_K|k@M<}LOP>$D2w~z*!_+N2l=nBdhN)Hnf&;Kl7sn>6hHk(l2 zENKRV!7Hf;=(7eK%RU^5v9S-Zv9S*s%F1%BRTu?Gj1wntOm@82 zyFkdZR;1OChp-!ZvP!8UA0825t3I{3%DXn-8LVd7&fb~fx?|M8_=dQD`_o*8!|bEV zp2H1c6F;rq_=>fR4XwgVv$uKEX2|z}-%@{?^AaeC!%bNUlkBf1kmdFRW#4vQ(1RMw zfhI1yv)fvSt@<#Nq;c5L9TNGPvY@A`coK?9hlOu0Z0aM~;V+XKJ&q`~s=WQlH8R5y zP2X&C^)@(~GTTj?F6ku$y&lvZt-k|&>-b77o~`Nbu6%Ed@fwAxb^;_UGBRoRb3iWF z(J7{CD+Z%8)v*029sj}l{h>UKQYwkwW4lJrA3IC^^_IqhRU0d+7WSiDxV^mjNMQoC zQ{JvQj8_w!_zdnpk(SYal^BpIBiXHq&$b z0YP_Mfenr3^ld9rMOdhe)w{i}=XJ^eYLVoMmR;X>>Hmm$b8b}TRJ;F3Fl+i<)FRZ_xrpy6TW-~#e;us0aOPs(7MFF<@#)j25@!`8+w;xfXY#i4N~218 zu_peiQ3Zqm7%%~=wgF7ZDz9F^;-!Uk_<2gbKA_(XtA{G+q5AO##-W>8QTSgkEDHXNr%tcpDaFKFmBD|Gqkl`87T|UJG46Cm ziAn(}S5Ps&_lQf%`RK<6`Z0vm3O-R&JlotCANm-0wFGJMphRH(>ASQ2y<(8W7&t^M zF9fO{eSVQ$FS<@ESRhBgGBn2|%zpEF2XM7%YYn_h6TB#C{_Ymln|DLj!|l3Ny6ktD z)~)-vY)p~MPXyYow3~keIEzruM|@aBay3W{`5kRgcLMS3CLUx{c8t+qkIJg9!+W*Q z1A-ed>)XB)(HPDCMJb9ciTxc>h_G~ELdjhHF;IoW784gu7m6cHBM+&X{wVFqQemwg zV_n=RVv|ga_}m^U?Zd`xeo3vVKlX5yTm`!5-6X+hJINwL;TAAh2!-O1Fh$zcpeL2k zn#Qb;MUXo00GYHnVs>1aBy-8+3AMDIfnZa)n3sa~30jIVp?u4SPIY})Q%X}a7LrCr ze!z{e$T*Ae#tiF(aSyXfnnmr+0!_E2qNy_L5z6AbhdCn;gTFuinB|6vhi@}h`;j@z zgGD#5nvRYxBcX_>a%+?^H`h03@6~Nay2r0g&IQM6ZG&nKAIuo#{OA7yfT;3!C>K1v z<=FkADsNSN!nOx2*X0;)(F0zOR+&qR2&aD)92k@iynzt!SSEZT$Y^p{UOhHr@$sSu zTyK3S(HopBqszBypy(5)TAIQD?GgmPex|s8_uy$do>jVZ9~Q6r#8b(7$FwCbPR>XUIERtVDOQU>R^4y?cf6;qn`GVyGv3j5hs&xc$Xc=@i1!+ z_A97&?fv=1PkX@692L`=LO%J}D)AL>^rbMM?(thpR8H=VCmVzmJJpXI7A{tZp2){| zd4)JD;-6LMc3FF@H!ZQv2wyW$ssHqdEeBb_>a%Rf?UUL6QjJb=^?&Gz${nQ&7dmYAg! z?+3aulg6zI(d-HqyIIM)3l>CHgKV`7-n4*leO9d3ze6_Tv=D0gb@@=5Du4?NIsotO)_6vo(4ANia;WFqZq>*x8 zB@(eeW^9aAZKi>4-o1x0AfW8Gg5?E-BjIJV?gpxoy!6HaB+d!Ybd2YOJPu|p4?n-L zE^tT=r02bT*Y>Na(ThDq+}FY{vY{$Iezy$E!a*7L?!`g|&pA6Ym-!T4N~YblasXbf z6{1@caAJ*UjAd7!?N_rEb`cH`p9e= z9Ei7yp_uu&bHuZs$()K*@~=!KLpfU4`tmAK9|{?mJLVJ2Ir`W7qFK_`CTRoBQa3xN z*SbAk#En)cZ?4a)o$OT3(s}gz4RoIQXJlsHf3#daJ&siMKi9sPqjg_rAQ41*CQLT8 z4&KOg!odkg)WSXGu7n>MdKB5{_~?Sp zoA7AK;-mRQm3mY7s2jF|NdYk;@x2%9FK{@h?nFOuvg=j@n*564T!^pp5Cc{wHEzr$K3TtY-xZxu1K&e_r+ViD}EKS?yPCb1^ z_)+Sb!b36y#WtQF&PZ28^Lci%Abk9km4lG1qBRv*zM?oV6?+7~0M?1XG7)nFO$4IA zd&>5|K-kaaM-EMHetLE&thK2=)SVxm`+BurRqpwmn{S^2zS@Q)K_Tkykht;l5#B_6 z2=E=7aTkYgnmO}SiqUuWt!=3B@K{T1pSZ$fyW6d7COr5zY1ch;s;ljSL0FUgU_I9l zkZbA+JK}X~!`%M4gTUN=uAxO~wy3oMwV4|pIoq~vmi1P;6Hp=X((Pc9(~#ZWM~cao zScJMT!^A6$jx3;uHzt*-cpYf^_8HyE&tGW7@mK3(Z#y;mU*V@F!&mJE_fj+Ww!H;b zNB4?Mwmz%hszunNx&yAbc085gG2_fhZC`#*)(eV=o&w!CXmkdE?jd9-W8x@Eb!f9H zu{VjZ-qsh`cpP#tdWD9R9immxF^RJQs-F+=$ zKvink8?4F1PgxsHv9Rxnrxwn9OD+BRdputo8+v}qDzY7n;&Xu+PQIjHJ#rWTeA7|} zna`sB)fK3^5)5MFZvszy`FeDp)jCb)j2v%G=#(q!k0v=q^<#tHpVyz$HLah2RF6*R zI-3PMesepmX!=Dq0X;}~(HiPH#%1maW^c_LD4*1+X!uallcI5X8Xa}V*9YY1%;u@> zR#?ke0aF*)JD|1StyzRF4~giTv~5U)D~$=v255?yUXlx&`sVPE^`>|XjbDwqm&(jf z>HFhbhm~?DIV)53+g$-3wQ&Ds&q#7W$Z*Gp!3zgE90;tsfU7=E+xT}07+vbt2!;gU zN0gWSyk@m}oto*aknKwd;11_ z9V|blgemTw$B@`8z%m&qXn+BSW%KkzP-uPg_Qp8j$5EKQ@p!GT`0!7o16mJ=9D^gnH&Kl>{9oJ))T8r1)|p!YmXW>WSAB7Z|Uo-yq6;I4U} z;dgQtScVG>ngCTZoLO1fH5LMLkYNf84d;o|kc%yu_*f*^hueR4Z3-&rfMgU=`3ivivo7I5?YJ`}r^ULU$X^ z4FUeN;n61BAzF~KTA~%(%zeknF1NVG618octb@WfKD|kX{6jzvl*fUf@L1qm=KV2E{z2G@HM|u1qQq25%70d^3Uqg zvN?b+F()%qOicVB;I@&l@l%p80O!;?GzEypU#AmryJrGFv}cN^)_Kyi<1zcHfVTWs zB+d^>cm3V6nLmq3*$XmYl@?^EQcB?W+vfwa_q)@% z7cha_F`tXN$~OX@Zv&W0tcRTvcAYcmdbF1m?m8fHvFf z)Qy0u8&GEzlz+bdrwyN(Gj;X!OisBuziXtxJ88$cyf~|V>$7u>QrIcVdn#!Y}5#Pl|Fs61pf2InK*wmyAf(r(G$etW*lgu$$_ z00UuMCR=UAE5V50ccD=BcUoZ4_={=bnbtMv20ys>dZ|fqZ0zZ^U{KEM|Bo1-TiX!$T7q8%pmG3IS2ucUa)P*jnKD`4 z4Yw~R^O#sIb*k%BJu~6}=C^Gv5((*4AHH5chyzS92{iLf9>wdmWLyTGEKIXf!moZRUM~xOK2jWxyIqg5G;YQ z%yYCDjop&lnpiItsq6I2 zv;mXp64M|^n?bc1lXY+6FFn$Bby-$UyuZmXx)SBiWmuWeyLw^t{z;fX9S1gypJ#0A)kcEel$qEXs=WaP=$Zsav=3;o?&Q)y^~lQ-qgkcL{oxO<71|BT42hY#Jt(_|E$gt>QekSPwKmCP={f_ zp}7(}?K-Y4@daP4Y&s)kJ{f5S8EtDS#2*Lb2Y!c*ioe9vZNd4YfM=>bsJzjthh%@C zu6h~mk4}laCpW(#0~ocMw+{v#*`Vs)KloZDl~)I`W)#rdWW9a5n$is0Q{gTy(~^&b$^~b$f84bS-=gc`cFk%$Cemr-^WW6zF??qSt zBwvxOugQ73w;t&gO{LS@kKj3(o0^$?wEQXJwEHLCy})Zy7l0K1-Xr>Cmx#1ivck9Q zy3xyu>gPgj$Gxg~NSo!|wHyfOBl#J6z7;#M>28pr<@mwO6wxYkw&jr~YF`V<%JCeD zbO$5LmlLA-_RBDFn@HDpfRR#Y=u@@z#p^IH_?(Fg*jUvU@Xl-p+Eni!iOetq9>b4c z-^<;Mm{m2aU8WGrS2vN+gq=*XTdDr+$TI4my@B(nHH}eZ-Y?>E zs^NU7@VM`Ssw}|2TjIF>#RhV83l5es5p-pR&H8zKcZ9Zvqa4!+xB1|*ezPwT=Q};c zUrjWM=Yytse#z5DZfJldyb>S<;A3g#x%A`Z;nbH2?FAkVHz3}BNcku`5y zX`83Jqku|j^uAkszZnoH1O$cSsR8h*2rp_SM7 zQ^#D-Ma1fBBoDUmkH;MGc>HubsL@Sl8i1MdewvVD!yUgB zA=lde9FeX|gJyqSLoPe~clzbDtaKR*`PARXe1Yu(>{my}d%NT5?1u?c%)Lq_&-zEb z0y^IsjqL3Y`mep2@$hynHG#zjTwo{!{M6QOCJ(;7V|0qo|7Q!z-WB4c5vVzc)Z3;T z%(U!kB6$s`lBq9$9%y>xZ1`RV#ZzziuK!S4sf5kfoCT^ZDY}oUizpj^JAA!AF)iRc zy@cmAFlROrPZO z`e&VC&#p?IS;V75Qwh_ZoPkv7uQ%zBf)iAiY)2?%fQEz&vi*6uJ_MZ%iRYjZG9DJiA76rPH*^Q^ALnmRinAP zArE1fC|k>wa5LC<4Asr^fUWxyw3zd6{MPplZUh9zLiSO%7pH*qlI>LTTUBlK*2n;a z;M>~ifXETRFR}ppE#1!_Yk-E4sk%+Ln|CLijtE$au^oD|xLm)Sa~2M+k>XR3))e{@ z2>6?(k<@`al+TSvw=eq-yxeAo&d`WyuSe1WKm7qG-!lo*l(fsw5Bwo>z@m-mv35^D zVzm4@P7zbhC+<2&^s#X9eZ-UlJSzyBb3k6hW9X2wYT1wQ@RpF_Nq21~lzE4&>2IMu zlSohixXs5~3FFI-zc|3@;Rp*X++w63x5qyCc|#WJOMyH{StX$zEp;{^!Z)DKt@{>D%TH{-r zNTdx$s^)TTUHHf~yh^4~LTD7iG!w|ck8&Vw+3R*3$AuW-GYj{|n&02e zb4Jv-uc){Kc06Ib0-mq4fkW7aSTCsxM7B@JG){&WzU0gd@Q4suv~$zRgt*rh{gBM` zP!*S*G?#QGn0kH%-Hd(*tODp6T%y3iHIdyp@O!UFz`hx{`ZUCU$LMni{%ROb2>KxZ zfGkC|t@z}~eOX#&rx9y_3hb(^J%r5{=x+ux{BX5Zhi;6QO%7~qs^#mZW12r$?LFbp zuPr!70$Uxa+R~1b=(G-n7o;_h#Hz2Z<|#z`ef*4$_Yc-|UH!wyBUi0GMbJ1$6n96B z(C2~@_3g)tX65CYnA7z@v7^M!=d zzp}sSJ+td9E=g*@QN76W9$WUl0mEz+n$a%~)wr~wnkHaJcm93uEIePI0k&NSZbTMw9n zvk@*0l{Fiy**-0CffrwK@Y`~Z)&^gE}rSRh^JGgS9 z0ST^^QA-sCnFXN8OpZH>fG#lKE{ex<_-jhtpfQFZ0|c@$YHU>5PcAXo)< z%k=yJZ%h^*W;C^Nn=My=B5?By?x}Y~_5x0x4P>MUNmHv2IPK5cCodOpfcrV-(u7MG zVB~28GqLyP1CYke5J7rUXHmdyIr6cqexwf7+P)YJc!nEGrAmB))xAxqI^kQjsw+_% zDbo`y;Oyz%bQ6)OpJN>NwkRM(%X7)pU)*;pQC^CHl8P=(M}*BFpxwBf=Jnw^ZQvH3 z@9g1~0=YO^WH%F$)LoC!Unu#LLgm5@nxl(z5W$I5M9Rf}J}IA>@NZPO||+uc4w)rqShzE4*%m;Tl-s%{I6Q~xcho(oWQ{G35UQ=ZWxby&({ zz>|f|0DQF2B{sE0H1ZjpSE*h5e&bC7tGxu43xP>uK&JDeP*A$Qsck!5$l>SGu%gXi zDwVUq-z)0=rVXgoqW=g$@Gg(vYZ{0R+s^&A9(F17^Q^wV<>K(o;1zG*hfRB#;bx_e>9Mno^+{@^8GL% zpoU=UQwl5W$##Hb{}ulQaq1n*qIV%UXo~%#pnZxQ$cr4dVK3AVC0ghwSAv?4Ew7$i ziH!cTPx)WU2{?U!*_>T*OYP$4lBT=Y^uhM&jQ`@^ljMe44B3va_$qX0xiiD%s7$5h zYzpXSF%C%|cmj*5F1NC7ydv#t2q)U?xXm3sy-4^t<7Q+)HmH_yn;w_Dv4Fqqf5f>_UVfy3`B}O#<~t{YMW5#7^t)C`D0^x z;GEWl^L*5ls+*q^4o)n?6^oIFa;PSzyQ~aq#?;THOzVr$yf0msoPRvccAkuU zdY2Uu-+2mEmzCx-g&%w79B)=DmL(pe$&|<|rcpUG*n@}1XRf74F{QYaPLf$F^2GwZ zHQNq1wStfN4Rt{ArQy5La1S}xTyruBkL&r*7w z$jV{d{&@wf>C;4WXJOaL!P!+V3mppK6^m16*xZ(MalzijPbje-!cWLyqyW#<4O55~ z=6-eM)}Ow9hRYg-fv}jtOT_^Bkeh@r&A+c0K2wiQIWOM`=jVv;SB%5N64HuSFv_-K zSNU(>xuZAj^u00iG}~KGZ>BLw2vnzHs+Dj$HO@6tS~tt~k^AlWxoX0C3N8^%o^4K0 z!p69VwMcwF_kc+Q__F)^-6qdHT}I6)dYi=lelzE&hJ%rz@oM;siIhWTlAVPz#+zJDu}s|)uxZ*pONA0Z6`|)^z50P>4qM6Ytr;oXjUl6xopQ zse|f}6^3agxB z0e4iU$bozBbhz=0Y2DYEvgc ztpcmE9Sx=HD#MPBjFuW52p3rjxlW9cst?ZkSUpamlmKtY63s#AzJAdwYAYVdC6YP) zf@q58^y!Mt%53$1bq05Vqx`6R_7oBmGdr;NRXtYwb#u2NhaHx+-03z zuX!1DZ#VIia>18mp7ipy24E7AQ;I9|mPSs>-^;stbcdx@2TcJ`&q9Uhltx|GK0l`3 za^+VkrVmqrmNjoVD6e0-L%^DM{!!;!O4STuSA$LPd!x7)TruuL8{TH-EGoT^Z1UHK zzQh@(CR(=gA6lRKjlni{-Lr;1Bm(${$GA1%2I6#zy3^i%44I>Q8MH$cl#m2x; zqr^E)aVKNYxY8@vAm&{U??uUlT1pWeD1nu`;M8 zU*!~*vb-gm>iJVkE;W?jK5OwVtEoIakm|#m2m#)j-{N?eHSiG*klmYrleD&UIFZMA z3wkQY=1Y%VBAO?oK3-n7+88gU``X1;B8>gO2WFb zU>+nC1prWeFs&vZ0o9k`FF8TEWi>U~={1DcWv~3%YvDS{w;Yj4n&Vnk++j94h^%S~ zZ@wyT^T<-s=>dyeY9c`wc9#is+qhZ4<`C)Wk~4=^ziI9fg2HVb`S9|SQyDPr@TU&6 z7)Y<@mL(iBBr^%}?EZZCJ)fuhoN8P^X8JWhN--jA^i?|`>qf1b z?7WmQIri$I3lyEP45!CfTmazxs3D_Q^su*24%BLyn2?%UfM$blmF#doDR`5{=%Ugy zFi_Zv<@Ln9@eM{sc^0vEZ;TV0_A~M>s{*>^@>7KUNI}mjhk74i8kUYZ-@3Pdaw216 zp%dDPOXru!3{8aPDP<=*_xjOEB%js59BWK=K7}2PEvT z3~KNQ_L75m2F9hIjyOe(h}uU{Ld@Zop?a%a#tJVe6RRSa&81gB@rbkc8-m++n67H ztG{7tRnA6B_k^T$&^Y+4Q7d(#C9@8hQn`Nx`sCaw+4HiLC@@R-zLHP9LFY+v+^ z^v+?+!tR4L)tdwb)KzWC;+`926R3`YfX+Kt_nIH(muT*oIZ$K2qCFg(*lJh1a?UkP zi;2l}riL<9hJ6$YU^SaHv>WYeroS+e(2yRs5{fR8p?+SfW_OGQ~158{XVjb-J zPUjP!tW@f|GbmgMgV|eE(9=_%F$iXc=bc0IN%yar+Lvo1(u0(_|F?_#_fRa89tSRH z|A3^n;4#h){c~0T?Dv0m1Hb`*6`)id1<|(voY>EgWKc`@P4p({C~#H00zgAU05}9> z&XwUOj2I$-DuK$6y9oYY?&aV9TxRTb`SkO}a_z+Q1eFk6^T!mK^Ov4mH>)VG2WSAl zb%;1+2ao<2Tp5)8S8%1AS6RjU2snYozZm zf6iF`c9{S8LNo}|ejF(SeQoV#o;fFVn3 zxQ^cdp~}sG3wk)Lbou9?=bvszd(*Eh;q9b9^gA^EHIn~tX#6)c{xJ~#IZa);`rpv_ zZ`Js}ay*0IRpV$>A@y0aZ_a20-e1eP!K2x-eVsy@4s`Tt*?Kc# zbfsgt$1+ec6YqDKlK+ckDu)*+B3-xs+6TINmtEqjd@8rZ$598O-$nf%`G1T0|AM#v zTh#ws)c=!&;lFtIzj*imZ+JHt`XsmHP08y3j~E@2;J4TeyP6WSFD?l^y-@)RQyhIDysp--JD&6q<% zL@<0{)swAI=Q?+i_`y${%&NF4g0;d%w`}@^_I9Zb5>fRX$K2Ir!$M`QMXPlyx1`gQ zoxPS*fA@f|fx`fZ%1p7}or{XUI9vEP7|DVvP8g=C4!qcxSOa0Y5vrga@>o;%=}~8^ z%D@B=$ zg~`84)SFUxz@amle5X_;<3g|UAc^!ovE>ui>8+fTEUp-DjhlOTKQFJ9e4y9d<{Gie zIzYcK3C{xkq*iDp>gnq%P8{=80rlmE7U(%VZ6jCEy8|={WnT;1zw3~=l{p6->+HED z!^QDGMj_1qY83JZO#VyFm3G7H%rqzI@i1Krm(^k25B(GdmBd1{=jkLkal)BYstHjh zp6iATG!SnzQvlJ*^i%A{+doH67v4Py8sl0$_?Ki zJEv=nb0!%nCccBZzsWbwlMkPHh@w&XQIe_iL^RLZOp%eys)%#%VV;X)+4!19?1+79 z_|})eI_!xE2b+EM6klq-kK&jMsKa$rWKWv2Hht(lVVMYSy`$#KoT6_71u;~U>Zv2iRDts>7=2y zUOsQp(Hv*OoZnehVBL!Wn~TNwIAP&8KMJO)3{Z_1+PLZW$jF$wd+N&CF=KEexFR2J zeiNR0bfDV%9i~kq3UQ@$c)x&0?{8-q0yAXWrZ4IVO;Mr|eOke9edioXl~|5g2CWwJy(bwS*Lp% zMWZ^$EX5Q(;qqN01GZh1I^(Rz<%~zBVx?GlJyb~-tPx>aI2$%)yc6BSfvWSoQG6_& zD$A2Dv`~^TTo*eOpFyh$#)oOOzfZ~(kjTk1a;oTfVWq4_lT5uf{OPNVw#I%?G6$Dd zy&0_hRy>Dev9|PyiONha8;3yEwdnY(W!W@s84Z^h!WE#`ts1UZszh*8O8qfV1QPp; zXrS}Oby-}c$|D{gktOr7?o@YjSvHTgpFh7V5*eRLuVSu)GP$5D2BtdscRyesF(ix{+s)>q>J{lv}$FPI}AJG&M~ zsbTfJ2HCyA{D74XXMEWvjB zKba*6f*GfNV(+PpSu(}tGiHA+E#~4xX%DW^k!Yw_Lo|Eh!hFRZhzV#b$de9h<|(O= zs^lyC?-$+3tUAS?V~yaveqG0Ewn49XXV$@FvMM+C-51IpKt>dhOpi6fxkE(sKDRwT z{@(bWUO}%@?~w8f%7<|}wYTlZSFa_SKMmecqR>Kz%R~}3>%72K(AP!AXMHf)HjY&I zLN!~ZkE}58@f9P@kylM|&3#+pu5?o*!XA3$3`J_;|h0 z)9Y97iqZfB1xXsE$~(wAzu^!3UrzY`ZZM*`bFm#elxJ-MU6<7%)Q=%7@-XSr(QDlN zF>z7g6cu?ZFZb1A+Z}0ye@r><)kndj_Ek9=NQa`gRR7#x&osJD*u|#hsYhB|1}u+wOqQ@fJTc^sI!4i*11`Z1T#7$?W6i*u|l|kRWi0B9u_?^W|Nd zRlC?5+`1&uq1rKnMX%oRt2`Cc-{wVCIKJfE`>+uc^O?+_!a{e%-*pBay)jm%s4hAS zwo~TEPmlEU`Eg%m9xkuo*MES&8p!nyqRoq``C`Y(o!aTyl9^|6%oZuwbW#oDutch8 z*qg}$IIskbAp&)}uskl>F;Z2)_%cg6W_jT2J9rT)rQCT)qroXbp;qu^rA;?%=1vuv zw${p&-p5NOQc}}VVHMk_Z@k~veg}QP0SZduuY!{JAo-rR_8&F+-d~G8tQt8hjHWx6 zZWUcb;6I|woKx~aR=oVNV0}z>wZCSV*#1c4QDS_SW{PJiNXqz2A}S%s zv?Xq}S~Zs{Np5{uwMAx~v+wcc)7qTXikMIA}Wx=}qKz55)eO9B~zZ46F$v>%IV{o#B?z~lD%*P2be16@PG_nh%nL-Tvj z9B#RITc&1X7n=oNx z**nhekmeFg@a;oBqkgkmj`-F6K(C%vd6j|w;^Xs^0$r$zr*^~!OVn&wn1Z153d5=O z59ujiQ7DrSC}C)W4)Ma#s;n|Cc(Sjksy zYGy>C`Km!+PiiwAZPra#@pm)t(PYyIyU(kp%tORaLY_Y9*EA$%3*j`#^YHU5dJ|>g zFyGPQq%v2VO2~a*si`z#9L|`0FFJ2SNB*FdG!gtN!Qf>mh&Rkazr=m|DycC;#4#V$ z5Z7%EQQ=t523lop0&(rHyIT88wjUd+T?vJPisIX0RisPtfXmA%WmDhJ zHC{w2Nmn7Ye|7ymJ~?lZe)+_=T5B$LI0?jjxQMJ?rko}VY(TA<;$jSQ8?`yL93h>m zv&Uy)Wz`P3c~t8AkyY?zdzfA!DI}s+)OdY<)aF}@FTVXw>ow925~t`@^-|rg zqR}R;tHHW4Kt0rTme<%l`a=Yu^VbN+(If3t(#f?RSA)^>BRsPRGx?SuFxYz!V}m{T zK#z;)W<2FaA`yX|GA!G$O|2O6;|wf_n#bzJy>A_3+xDqNbltY6sm>qh%IXs^+R;HYDV5?K$ z=W6}Me0n{)bXrPSq@3olx%Btoju5HnZ|)Zi=2bd4@ZxKFtNtbDQY2}=$p7EZTNlPy z_?=JH{LmOfNweHHkxVjYuhNCZ9?HBp@<|Y=XhDZd*Z~hvbBKe@1%#a*qK(24n&(BJ zo}N0d0Y8njO(olp&p2_&Z{Nz~y{;pguy{N_uajc(Nd_p+QtHHD1l=ZguG=HzrXJO!t`px)Ge!dYf~@ide}wk>sv^$bN?T<35;eO#qEL*ikR6 znTE+J$;9**<#0P6M%5+J@Kkx=q>f-(L9*UQAt0Adb|q`k!vd*1en z9uI#KAs>}$m{^+L0-XxpFb#X7Hl4#HcPyt;c+Hp8-XYrqc6!06eU4WK)zd1|-rL2B zZs3x~SYuA(N+Gz_6{Rk2C(no0hHvw8L&ulfTp7rUXm#S*3U{&c_!`wsgfoYe#$EdAU~3Ph@uQJAZGSToOiLT)#fjlu}80x+o9CSp2UT zbJNpU5c)$gq48H^Og%MG*%8^={DrxqzKQ}wP;OZ8xm2t!$eSv%(K2!RY`hqk*Tqh+ z?+EMjrFe-9D+!*-;7`jiR5r~{E%oyKv0>xsi!{y#9=?0>vt(Q_B)<}b+3VpQYqU`q zJtmpmABdz*Dq&&NO{F02sT;*Bc|g>qFQK#E5Oe?3ol;k5eIbNe*{r$ zODHJP=4@e&YX%2#tIssUEz}}e>(U6E+Hhd2t3nnldX9{iVsCHrA$@%UnSYWWC;vIg zUwghmAH>{cAMsgtuXRH&HkX{3I@F2a{AY6_8)X!UYKZ{%w3kiLuD>gWov4R2Z>Vqp!kD< zes@Ld4h^S7yx+pV-v;dRJ@u{$=6dQ=2x}%54M@i8+s}q>GJmkp4!g1+U7}*~BcAtR z!U;+6!-fNWz5Aq~2;10&x=}ICZBPEb*CYs?f}YpyFI6hW;%i?_=|%{vvy1xk(PYb{ zyDxf|9;i%hc2Lo#A&0y&A#Y4!7aJ*m9K!2MZT_R z%fVI`eCfkEbxwh?-j`6ySBu`3Kl?19HSpce!Jran1#R>gBSuL&Xb;!Las1{GG(kyD zu2PvHQczNIi_BC2eDF-=*)i7&>$dH~;kdl?lcL^j-uJSxRYrR6lsKqubx#`<61!?` zo?CGjFSSOoD3kYK0(9KP^f4C@>B7v<(<`cXusR%}x{iiBUIYrA^=xfd3>)qRh6Lg+ z+J8zATIO2>7aPc*rD&h$?daF3h#6=VQt53j+OmIOlyOaxoKM!7>#%ZgpqllVzYFW1 zt8}CQ9!(~sS{BCnVtEd6Hb!PH_0!#NYZ#ZuP*c#dliP2#DP?w3!NqB$k=S{vC2Tp{ zHIX>yPH`;FkU$ywq`!jOZ{bsy{Q#ArK^h#qsWn7vI_?cTUz0BnP&Jo3PuDxjF&V@M$an4KWk>@h^rM4jz?#acLz9wvW`I*J^U0^94qFV&-0|+BbJ(v5uT+cQ(8Pqle zdm)s7oUL==sSI>KE#=bG{N37VVfM2u$lXiC54|^G=R@rKn+B5~_~+}hsFdamH{by_ zPUa*2H>9%*h}ioNg4*IedJ*ce=BXJ&NRLA*Rq@t(U|y5dou&^P)J6mq;X#SsN^*9- zX=ki8RoBq1OtI%89Dc<8;r@$h3ZlB=*ceGA*U^)Mqy4=%nq5q%zMCn0VLhtm<|Xp) zSHX;STb5Y}(+-e1q~ZZf8A_qL-%xvhIgiC}?wezJ2IC-zGfVSgMkU{7OAkx(ScTCc zo11d%p4u&Fc1foAriPHkzE5{z3cpyKu3a=ghk|s9EAWhj^E%vCO*iJ*HnD`NL=mz5 z6^!w+s!_4Ix1JBZx)q0xm1_R_nT$*$rRi{G@^Hc2%1(^DWHMty!L3DN?sh5#=CSum zI!QV6tyBo#dosI9SN~CnCAxC!nb=QO7HFN_@LR=z{p_e^>u1YoDSuRF209P0T)>ah zx$L`{PN>y=WS(5E<41^KZvedvys+G@UlpOOT9`CuZa; zZeyLKW%3t7)7mk{_3YrmVp6T{d5e$SPupv)Tzm*_t3Ruby+^7aQ|5JF9yjHp!`(uX z%wV^;|4lgQcQmVm0be@FMTT-|W~&L`jZg8UBaKA*<;b_A&X*dL{zzS7h+8)8eYwfu zfl}j_H}#djf5EYUZyJj|v1C{3=&ziO_A0!t^LSA>D%Mbw+iTE(alDCH8| z7BXm_A02sQ|6`=ylU+J;>ZRXqqn}VuHG2+WKUL4`RTA)Qt(()3Nr_H$5PH*%?iEF^ zN$UB==CI)Yf%Zm%ng5FK#(Z1#*}l7n2ViSKd-NqjG%-ne`EfRk@!jtN&j@s;qcdeT z%85xS42KYx=vn{u&Ws%cNCcITgR*5SP0x$cwq{duX_~zoff9Zd#v(t<`VtdMRpaRb zL_4t8UgKm}N$XIE*l3a9TXH!Vb%2L0{ppoJ)$`YaQP0L#lc!DIK1d_!P7Z-lry(#v(hIiJx zWYr_FK#Bjx$=iz%9%LY+KS zKQoSt2a`Nn%V6F)(WvG0uJc3Zu$5ITigVG#DRFJj0C(IhHY~rvzvin5WJ-ByZCiVD zdMqwan+Uwy`$VU>&j;jtIMV3}@IeP7Gs&YNz^U@-xm}mZYK8nDzEzQc=4;WitojF= zPgO{ffssa}v?RG!R+jx0T`7LFm;CQvRV%a^q%}`U#%<_vTW|d#hE|j5BGz`c# zRpX;IVJO;*0E)d!A)6xi0l1HkfUf)eUJvAOKG_OPvt(p2_6!6@fgZRu&VTdW_{f$s z>q>{R+ZcJ%lNoikv+Xb&S_~)6U=lE3RKlBQCxv6k}yQ!ABAnf?#wSmrGt5CUlzh&4~cFVoPC@kZ>EaZl2Q%3RT4r3)6pFVxf@mOA2DL?-H{eIM&g%VfV zsI$fya#GJjC3E!A6vpZVdqz}}uUBp`uz7H&i5J6$s#D0`*ONbuXWXvMa%;UzuFQ>~ z^Hr%=KL_}Dr?&W!botF~g=1AUHAc{iX;yXVi?1&$$Acbbgj8(J!r~a2m^g~uS->>M z{@-CLIYcz#Y9v{e0(8|no+zF1UI-s6GpmlfjsQq+q@+X{%xIL8lhZYOqRSDB$TB^3 z+s);YP_1{+?~_s~fo)3On{dT~?-x3ocX}jW%CKkR3DT{N=}GxQ42v{@ue{``3P4 zTE-29>KstVvJ_KtIcYJYK#YHjM~&c+IFnIwi5bbPYOgt;m*H@m-b#1$8`GT&_#{nW zza3Ps;>3KW-I8;|Rn%`G0^+3Y-aqnVjjB0yPGOAHVw6g~ANtd3i(T$~GSOM3?BR&G zYKF2c-P~kyYj!JC{tMLeqpoOWxwbG`J>PN8=>M?yo>5Kh>%Z@^0-_>F5u`|{p(=uO zP$?l4fzZ21@6tQyl3oo79fEWc1f>iQ`g#K@3qez|Gm#R`<`)M zY+k{DK?rmHp81sT^ZjID5Vf(={G){n>0Z?A(fyg~f;Z|jdx)bye$tUBKk?KaVTzHC)DE+37wtNF3$t@t6XR`7HP zwcV{rl^rO+ZX)&VMP|msH*yt>eth6RyBe7Z(KO+C`+K;%@lm$#5&OnPFIKO_1X$%9 zOD2>eah(uE)mtggh0*1z@LUevGy*G^hu54f9WMiO}d%Ia|g_>?28$cg*46 zM8CJ)5cD5nR>XBCe#W?5>dNWgfJz~6NEjjf&iKv3_u)!(sUW}3z1D^}*T|DSPSW8u z&wMDt<_t~6XxzJ`xx0OckZSTYxH~{CP;8XpR@o(C_`}0VgH>j1H0%}ki1j2>lwJRb zq_8Eg${CJe5x>f62&O@BKaa;ze~uqOHDi&6Rb+~1WLqw zyP^Gw2L5#8d1vJAt~@+oYBZm(Ll?E*Y*<-W(VRnEojjHs)!37fS#W>kv&;PCF-7_6 ziv-%-hEMRj{NIRUP@UA&#d7y($h9|Qd{z&y=f};7f-i2C;5>#>C%ZtJ5xU^T<2Et% zNU>u6PdNdzT|2A4DSbRTRT*BhSbKfFZo3Cyb!1C81=C#nYa{d{TIO+oV&iEq5&n01 zzoSNow^Qffs^D&mscmX)dA=7VgCt>PWQM(O&8Z=O0oga>C-2lCnr0Et#-*5K&kr_W z3Or%P^lV2Mwk?|k$N=QNH7TTQgWuU0M}d0w)eZNu=kz)tc+XKA6|JfXzd(1*W>X%p z6Ux++Uj3Nlb?b$VhI#6`!#q2ctlSFhk2yO*cl>p+5+^4g|Ix_SrHy@_-n8LDTrkE_ zmLpZtmr-(SkaWZ0J*lgu%7gG%AP&Wdoy|t3k}n`LU-Fxq_4_yLzMTXZUqNNCpUK}2 zIEt@wO>xUsICpAX6&qqA7wLjMavWDS@t15x;ZrcODX*c}*a9;sls=BNYc6^gQZ#PQ$TCY;h zhiGZF0R4v2a38YkC9*<3laGNWE$jr-WOIJ9Ipot6rhCn7>%qOXdu$~qN=2jvy2(#P zKhAu|*E*Ll;b&2iO85ukmw zU*dY4pqcAJX@c*=mAB{G7*N+`D-YBC0Q3!xMMoO#aOwGT2GtA9>YDWv&tu!9X}PUV z9;Twa_t@Mq=)lvb@m$Fn(zGKV9H*`ZJkx(SzBVYul||RbyolPv?Mfd=c~zXZHf{%; z1t+49W7^|DDs*hTyy+~OH#LViGQ5I{8|EmoJ9ed3ap2v~LMOEQ?bg^l9|AsUTnVFK z`vZ4)R%y|tJ&>1ZA{Dk#v(Aozv9(qhmw1iqY@GUw5DrfFr!0;PGB>NeceIb}7e??- z$)(03?i-V@LnQn%j<#NxGH&Ke16rQ^^E=~vKurZKY+Zg0XnC5?cdmnLix4t}GJr)$ z+QrD9YrMpNU*r8#;{8xA2^nTN6&q&0J}1&V^LdHW6t(n9!R(=S9pm<{vtBtsXLZN-5!B-pKner=rjFDj>g;nL6tz^t4 zc;haHqOU76rNjsmm5EGPfUgt_T2#PNfrBtv{=RtuN4no%I4|raE(meCk(D8$RjQ@? z(7aKq$jpWv@`|7tV%Q&+;P@=BcCDK%Hrk4`>-zg(%a)v4%cVZ_e>5vm|FU+5f89u*lZL1Xzz;Km2t6klI|jiW0W!;6@L{eCYpWOn(Ah9Pdt#!2ko74(c-2XK^$PYE|9PerHHs?n%5BBOyB1p>Q?@s&6JYP@rEPa*q4mH0hH=M2Y$-lsA#6z<_ zZ<)!GPKUY7xE~Kj)_m9D>g-Z4jMU}ZEg6r}H{8B+7#gH8UOZHB8e1*;yE)%su>1%5 zG32&ruDfHuRE+GZs;T<~445K;E#`R?^~9qGbgk}&=D%v!jd1iN0R(v{Un3}K2ViP+ zAUCfmW-l$(BwNDM-Kz$!+PTOgQsgCaWhsBF>AHJC1TYqR8GnRq^e0)QpGFTKhRUhu zdRziyY@9aUD7EseHVp3#4!Y@M9f849KCE1xP+&7($Mqt=)adm|SOS|pv<2%&uvDB~ zpQx}`Cg3&s6KuuSKFW{pkBDo2e9Flop82wIDP>tQ2jrdSh*Ao*41@-EH%+|_Z=F>= zs&{r;>&ZB;p7E1QH@Un8xTvUmdDXWuM+SWY*I=Wr#jDU6y!5$jM!-0H?2%Rx$(B?N-kgrgv(h*c@laCq~f>$&o8On zgX~L(2D{y^{J!HVMF{^HUr*iAb~s=ao|o!`ZCjJn*r?syo{0h)h}%B)f@#J-#d*f_ zT1$n&zxMfT?)|GB_&@gftRn8CyA&zXm9pFz?BLd()qXXaa(qZL1^u{3nhLzZS^o0{;)tgFal31NskB&Y8QWZ~Vdg!be{L(Fy!Eva`FxHjmY-UOf!@;5{H4Bj&rno;<)%4T%q6}d)J9&;}!|(v>4+b*G zydP@13Dx*U3bk-F^ghQUk#e(5Kk6)AD`~KWFI-G4XgM&EJzmRa%|zGZBw)|c9a^WL zKVEA1LF)AeQ|;4r{+%_S7)nmK?EV+4vO!NZIi7fVDE5Q_GV-uhZ5U{R@+b-RB#Lrb zW~a<@*%rz!3}okCtLET$!el*tW)z?n-UfQAlq~w4Uc+`ZP?)37D8q$|m9KxMzBkrv z;{mdlV)CHY*Lsp(Cs6$18~8qh|2@lY?n;)X_7emSA?tuV)TsO!* znG3p3hfcLvWH`mUvW|yr>`_f1R)@*XH3-6@HHhJt8((VZ>*BqEiMR0Eaw~Enrp@OTd72gW z23BkVZ#dV}LOa^u;hjiP=64Y^G2_Xd;!^GuQ0`GoOyMVw)CFD`BY51;}^9mr`Mt#qCCy$Hx}Eg1(>1*l3I>?=s%Uw;;6#? zzN1%m#x(R_svbXQ_+Rr_n1_iF&=j@5PUpoec|M8AZ4{AtF6dFSyfLwoMT*NmIPgk2 z*x6Kk|8QLPKAh}YZ3gSopD;p&~`I0^YgV}ZxKU0nb_ZMAA*Q^Q>^aFvZl zW4<-odSHpyuRCKBWML!s+5dQNz+HGUvsL4OWaL@;I3g!Bz3Dl*|EIozy^X2--s+cU zZit3lQknJf%FII1Tt_0tk_9B?(R#J?>TxN=Lf_fhgoGzIL@K>=SBP6!#l;h0dPwC(0+dIy)8$l5NHmMXDpM5D|4PTV=lSM0 z$RzuY)D^?!)Sz7qAEWll6p|4ilp61Ybxiwf0;k>PE9s}UU_MR7!Uk*uV>b}*5y2| zKi3sPcQ$=DZ*4>)e5A-A6cyk?EaWgAR^>1Q9nfp0KcC0hn%E6?=PZ~v?$4BLw7HZd zFi|ViZAI<6wRj8)&lCb(wTB$4N9YAyp%|(0Gk0JST$MmB*1Pt{ns)HNAJ#=9vqx^s z?$*JkYbz@i$KG?b{n(ywklbxmO|uM+43kzZqbx}LvTIlumK`4cl@-23jU8y4vL_a+ zJ6Uj)C{v?0jmub6%WpHZiI($9k*E-t3nogr2?oF9aKSi$J(_bWRD3e)DLzMCGB5oN zY~vzlNin+)d8T0qBVR2g&1X;82Evd;9y|Z)oy5k*w;qh0IgM%h$3~3&c3Z7|x2{m`lMtL~6mqamE1u49LC!@lQOp}JZ*RnMrx(yhvuv7<1bvQ>{;*wUS2`qr z-pQrh`%QB=HV~`NpbC#xNC|8oFz__o7nlw*n(jk{tDSVP^M`o!)_HKn@ zFq8AOBlWZh;|QVj56tk6MuhQ-rK0aS8|2H$u4B-dPEdSt(NVemtg#V9YYKl*KohQ{k_1U#PscU6Z6Fk2~o`9Pd3=Hh(Ntv&VUGc;M`Y3xKn{f5SZp=UGL!pWKzq$p*()+2=<_4Toh8&);#~hEcbh zEN~*^Y0tPJM3x=Kow2GOnXPG$jQA-?7K_QdR+@M_Y%Bdd79U3abDryS>+QM9`QQM5 zO-tfTz-gxLWuAJ}ofp~muFDLdm3=E99Zb<-qEh!&iz!yl@(} zqXhM+`Ee2iNU8Gyp)CDMd|?SzuBh(3QCtgelRb4Spp(M1e^e)^!*?@KQ|tW1>|#r6 zT@W<;^y6z8!Il0(EiG8JR14T_(U%%~XF1W`XWSLq!llk27m+M*Xf+T3B9ZKckJ)OL z$h#Pl-&f+ISlse`Mk3{K#1jke*hN;(xB1He4s(Od77|Ch4DVW%%v+gSW4NfH4uCjJ zq-Wo{604Pj9Q+=qXw-Qw#ZWA(q$RqYr6i~AtT1!4iv#tFS($n(ZIWg<;c2RgvXv*- znZ&?+GASu%;($?PK~g$O`M6APuB%8HTUVW(GK5i+?`PJRCMaDS-8_O99pCXQev7$* z*59lL*SIhQ)aWUAuWlhrec2%O63Va1wa_o7JSacfRCmE#=BhPL`bm(bQv?}vvzb@z zTu7aKVGA8wIr2jy&gaX@olAq$AShi6zepNatNZhC*WXMujLZnmSPs^_uSY5qdR!jR ztWQra(CZ0=N<+pdDd`o+)5^p{G+qkZ=q5_5n&#oE1Li7b$*L7j3sw zRwL5w4N&ClKO3>*ADkZ=39Nup9(ulx%OI=?Cm2*%%V+rQI+psjMZ_1b7S}VuQoSP` zj|aZYtgL%V-M=ZPop}tnk7oloPUoQUkljTZrqrzC&SzjS8t)Xr+%w~gTX$RI6|RZ3 zs=ojH>vM`RgR`ZRZkXRvk`SE;I3;G&nD`iJg*F|F5mx$!tecN*lz}Y^ z8ws!6TDM;^^&P-#A~Nj63Lg0KR;V~f=dww{9ky42{s|fBW|~TVCEwcMu@_GOEt5B! zqwjkc?Qo*uN4NUado|w9*D<1rf7=M29?dmwzEperuk8+~RYy--w4Ty|)Q^Z9BQtAG%3(;Kh}G;T+Rt z@YkU@c75JK5-9S`d!q=$qL>jJCE$1Ugq$e%fc==Jou!hju>K91a^|8aS>)^Hr5whXyTf01L zLelMMq?33_qpg5c1}u3`kt{yJKnOXzIPRJFHAK>e{gcR>;C@D)1VwTg!{rg3UQO4QD@ktMX2B%bcC)jCOh{ zDvif2>dknkiwSUkoj&`RNzRLF88Y?oj1w|`C2|rYb2o4<6+3Szrz-(yrVIcY+Ktno z`BR=+)aM<|rI8u>4oy}&aI*=lX01P0cGEv*AY17WVL?cVH$ry|UF(W;HmUA)5C7nO z+*ZslDf{7k4<0jEp&c|X&dZ%)OjrGEN;>NEm|T`%)hF@)B?vtA7&DvnG#rWyx*t6vrMNV{Mk@}Tr4|0`&qdvB|jtjp6>-54iqwn4^E!5d} znzQ(Wppx$U4Wb&N5%hsf*5HY%^>=o~^;$&?!h3eMqxYWi28zv*9(nBQR!W$jSYvcz z7t3y|EgWLB#*v>HCA`9}8qdXv6Ofg@`y2VdaeS6OX3#lNQ6Y$*aC$r5%B5`Fp{^*W zN!P6oIG}a2$)j&n(uAL|&%wLjl;s4B+ z*WVXLQ0SaJfpW7u)BRwXQ6ajjVXhHFH|BBgigwiEX79GbsUd% ztNYwa9G0_&LfUC@b3#=Us;p>gDiBS9fPr~g5alD6)rbRi7(0G9mz5Qf+ma5KUt8U= zHk2`ac6B}dh|ywwd6P(YdzUOy)21z2Dn!%aaZhnz+vrJ7Q%2yd1v?Z5;#G8;(Js>e z8p9yIx-WeOf|uqhn9sn|>c&;gc(y&yN%>q!cQ;?A*pM%>O=tuJNU5Msgt4tJGL5Nu z589A7Y`@o#?0yPm8DzI|-EA{XbD0RU1eaw`&W{wi`Zs~@0{6!t4v~~3OJnF(t50bC zK!bLgnf58y=UaGCyB>2qw8cj8LH1fg)+RT)lg*;GvfbacZ!XuCFlHoHS29*(W$fD% zFSr0dE~-aw8d>2`5btitMzuSh^4vIQ^qH=6Ct#E3-AUHBWpwY?))eh!U~5XY(d7+b zS;hbXTzO*4M5q#ey5&*+gInI;I|ZasCQ@IGbM+*LotxffLoi|1^w=L-F)voo<}dLx zjH)4hHG*!fvSJ3ecj_NFiVPR7Dv$zS8#%3n^Q4F5io1ft4IBvXtk|Pj3oE zSuAGg>L*l8#9f=>M71_sBdp&rFr7lQir`?2+yDm|z2S!MVeiq90i^Red1y5bIQ*imAGRfMjeUxlmmR<_K(WaSyr)d~Utt*uPpFYf*VlPee+#p9EZgr)6 zC17KuG^^|L%7_ud=?1YO*KN(~w9z@1OBy9sku!x64!RLk)5VoDUu!8dQj~^QB952| z*3leFNrD@ZE({>|hApyZiOtk+GV2A4;y@G*# zuD9*l6tjwofIVhEH@~z~oQ9%nOUNka1b$T`+8^S-!*IG;UZOcztapB5^WLK=@Nmfb z=p<5|b=5F1`2g#Sbv6_??dKY}BQAZ~9m#cC8O9CzaHl1)c>!>@jAQk;H8k{(*B%nd zKQsRL`o>1!SGKW+mXV?5Fx~PbxfCKMDK3wQm!nOACT#6q6#N9U1WQp#$u}Nl?Ov}m zx;D(fF1?e76)y2>kU^iEisbSomx{hj{M(0CCwe@JDb9RQ6{)~8kh_1jXk`_pXj|>_ z4YjV##)nb8t79s>1}3|Wc=+)9iOhf(B=l75r`86VOn8s2N=mBLQ`*nFd?yt%hf;mSCm)m~a>kRK zpS6>-R=cQWJik^n6~|S5_sg>Fl9Z+CGcgNBKo&J8#-8ql3MSmP|SFIDy-;8dOpE&T8ypq&HI zv5$CdhA@?ma99?^aja}8Ta&kcj=Q8$4sm`o;crO(s9f}Z{C5_)1z(ot1>l-PeuA@n z4V*}S>i8ic5=ANbDyPv|Ss+PATiHu7k%g-BZPBoam1Djn;pnyoH_(Rw+)3JEzsLHx zmjs8lSnN-0uV^$H@^jFh!hTujXJOiYPXGJA8A%{pK3>mR>T;d1W^^9V3loG6J=>W$ z5P=pQ!Pc|2^Tvn_*+3$9)Pj^t5)1;v{dWgvj<(Fl!d$F5lwNr;6rYJyiXM0@V+ZfTfbjP>2Nl@cVorbR*u#L$Z3!R3V2iK z6MJ3?f|J@Zof~%``_tbI`))=%xPkjLd0h9!Q{Ua-h+F>?VFx=oC6|j zn}KOJDyn^OOibiI*M7FQ53H8xDN5BMWG^AYe*g68lSQMo(~E59dw{#KHoRXXqe1$3 zvP;mvm4|9|&71@wkI_99`<}qmaPC;Q)oM4HdI$b!iaUl!;d0f5OMEZ8;)gw)2!n%y zM~8_sqH`0P)e;Lf21ZGO{SJwgr|PgJMZBS8^TPIG;mU?DlXiZRh-uV_g0&BRJ675+ zwC-hv5arD6ufZMZr8EQHiAHu2XF3Vo?F-l6obwq#L`6m29C0yj-_$Ph>ea=i$mYRD zH)w&mYd7o#8)ne)o?JCPup7?0UW|Tap#Wzu-z!<(oaTmkrB|h$)sq9MDNj{u7-Ej` zh-iyUjoa(2&!sfI(3twp7E)(n5VxiUv*iTgRxSO0V3KLGs7f+Z$%9cN>13AduaCV$x@BIY;%o zEz3-6J+`&4$^l8lcZMU^?ZFogaW@TNI(Pd(5I=!5F%OBtQIBCNlUO<#kc>8lQU&DV z%N=+w`3A*wlwzB}^jrH3v)N4CM(VH`e!qJrkU@2*kY?FtipbsS7U1v~<-9vi`l}p5 zT>AI6b_4Q=5kzt2tIdf^g_%;-Dm++EgVg{nPPA|C<%9ZwB7OZs$lmH=fPax7*E z${FWCfKi)n^CnmaB-Q83n%)3hvYSI{a!3(vU0W-Ck^HM!S?S2!O}+Lex+Nxp3m0wT zeTxc)*!$qNw_)yPdN0$ewr}OW^l`z4i5wDS7z(a7-OXh+-Bx*)ErA-~Ol19jR%XqF z-F~AqoYnzX%NG3|MQK8e@UgWD@7ICZ%-q+P^FgjF?i}*0di6WXY6@oQ(CuGjp~&;Q z!_O)6H!lE7i(V+}lkn@uD>{YNOZd;4-0Vnp?DH53Q%{xr)cZEkD0KNQYYKiHmEhht zs8R2pu66KeBeE=AOLJ&n2$U1iP_uxQ+Ca{AoY3NTCh05D>GqhwnD04#Jk;B4{Ywq* zTPMle`Hnp=R^DG#S2TYF(v)52d^6(fiT?-ff86`JUT$CNZ}p~hus*x8=u$#(KUPiR|hTmylQ zIW*~Hf5u{CCAmqNzH0{);vom2Ssec<3)J5_^L0|&->_nG_!5UBUTI#Kwe-}8oyNu- z8hU$sS9ni2jyJdqyW5W_=Vne?zM|~+ZQM`qVk}Rs zXM4;?lW>0U(6juZxcE-@q;ZY!cJGKuK(l%v*(vQ%4ViSNGgE+%f~m{Z$OE$SxBND( zOd5m35AmzzdE<|Kw<(m%3M?J;n^t6hVwvcv?`BC_?bpNtn1FFrt8CU{Ho;a zfr|y*Hg{(SSmLf2Z9U*Yu-fzOJe< z4}XDTvqjAQL`>=6z@}EH{zIR76v}t4koovDlqI=SNFw(N&$a2@Jqj(&F=9lSV?M9S z)}Udq*(|-J)(qZ|tKoQ!+Fdnaxk=KSqT{qrBW@)FWYt-xd(deE9Be$T-@5TclPeR` z$zUZzs{L*00;L9LpIpZ3&8}Q>+-V`c(c8>Z3~h#0Ob=E3r_(>A`WzsfyDe%7V@M-q z_d5>uIZK~3lY1`cQnF*iB>*x&-VT3_Vd>ZE?u1Kq=0{zsGirW*Y2jmQW;2=LfLM!y z99D&q9B1{{`|un-zT~?(?T@L2KqMc3K6f2vPJMKl5zRT_YvQpghfEs%=#TQ-7_V+x zdw9htX|TErCA1?v4IABQdg9b@_)NdbJ{Ste zv8RmgfCqe2?t#e3vHJ3S;W9v-fSG>!m|vjOHVp9t>q(<+Xe+E&^)UtvYO#Kq zmK1|=I*r285WQLEf>(lM8MlOD_HQeZ?i6s^@n4Y}ROg9yz@E~YZl4h`<~CXNi00h) zUR@k1TrUkxbEX?3iA62dAUzGm&YQd9le`C_N4~m`7_XvJ)=OvdRPx(0UQWHSIunWq zHS6U`%BGy+4D0qA)iJ{v1A%!3oH#q39L3tEP9{3P^Qp^PCP~D1p`qn$p7O01=mZ9- zUhllwpLw@2Rafxn$LGUeO8l5#>oa_R13++pPWuUfnBAoRc>;kH_ix;mznwq|_BNFX z#mx`*SUR3L!d(u3o2_WGEadca<`Fsll!btA+--`pd>JGa-oD>8e`&I>HOj?1tSmFj4^VKrxP{uqsd@ZwHxhwAY!*c%yLQRnJ0IvtsnY>k#1wUAL~0c`9vWFM1Vh z(VoWnc#tpU7$#{qvcYd#eYj_*l5t-787o)Hai{_s4HvOgNsQ8a zyyjs6X0|^|(iqAf>|=rTp- zv;H7oUyU~QrIp`2{Kd3`pfbND_%02$sS1*W+I~Cv95%=4?PS+cV4xKnDV#e%aH?hP z;gI)uM}A7@V?Un6t-2pSF=Ha{I-G~uS!xgrlZ~s)OZ6t*J8Za8Pn=k8BGIx-*RWj~ zT=9DIxLJOhJ10g+5;rjx_<3SH^3JhvWXA;xA8L}n?zFyZB_FMIr7?0IQnBUM98=uY zNMK79vUAZql}HGJvIxA0r0x;j9zD1=k7`!Gow2wQ9``+{BO_lKrhbQTHL6HIcx|)E ze^ZDe$DZTv9o?-N3m3zXX*nn_W=gm2AdalEI(Zr}LYjT?D49SqbW zEm6|tA5f7e@Y_G~?~9twvC{m0#;tvuQu!$QdFkxwgi=|?f@vDZ{MCD zSx*`;R__{rc==%Jtm$}ADBxt48_~^gxAA*q@xAbuM;WG8-q^M~C8Uf;P=vNj<>y(<{!)emEe>_1>2NhMKJn?=(&AD`-0eTm^r8?OoC-K z;)&lWIZ=s;CQPxqsVR;6B?B~`oLx?S&3`k4i!LKfOd~_2^eIwWrV9QDkP}jps~oYe zx-iaT$L|b%QamYeG~KoqWwccQu|y!PbA%ng%U=>t$!1eXwomq7^X=jkl{C>BvM><+ zF^*K(9m|-|N|yZ{8TMA5;&21j7(!eY=Vl5U{zw_~mZqmU{yqHL$KU1!2?q;_cB^fN zzJoqP!5y95x#Z+pMbZhgtiKncT5+S#oK7mB40Wez+HO;{JyR`>x7c%?vsHWWkgp4& z$6B|#6YP86txX#$!}$Eg(pwCn9xhoJwGO7T+@n`SmY4!~D|mS1_tNxQb-okXnsWAf zDeTc_`6Iujo9>-{F|u?N_9z|j2Q!|7Xcpv?97V$7X4oj^T)u; z=G+T*#aOuxS`YzyJ`Hrx*FWL>Vk)fK;_e@=THRh<_iROH>a+Od=H)preD<|j8+O1< zaw+r8JD30}t(zmYo6)%&4X1@DH~5c`wUR6VM4`{GjRQtdL_Xf#x^#lp_f9wWQVXE- z@;v9112SaNPbg-;&qelT`)(eZ1n;nd3S_SmsA&g$ni)JLAMY&j<~+pFE8`>GSZGbpaL$yhv zNjW{QQ|j=*2tV3)ve~7QTJ<$I(ImfTH|Ut&L~-a%rE_kv7PHz^vj&L0@f*7i2L z?wvil!6{Iz$gn*5g;^FFu&bx^KsqpLg~lKdr(orX>!N;N6xb&B*G5uX8&2p0dp&#MS{05ZiOjOtPGNF=Ew$eps*KFMtnbY5AHLF81M4I@!!7Cl(HKN~Cj_db%^z{e=%9J~q2+Fy)NEy-%jtwvI>BtE;q%A?Gg5 zZ4FZ%NZYo9ty41T0a765l#xljq)88)ev&yUQtiH`y}K3aq!ZT5?H|_&?PsBs-dfn% zU2_U7m`8}durP};MCVKAoy%o2`s*{q9p_F8M^|`vX>-lLqAN0BGPg(0mRkOd7v;;# z1-?YTOnbq;o_JEYHbVvV$+xS$?qpUs`6 zJa9mqQfbTN-@M%wGBt)#P8?qN_<9mVwXUAE42^TZ;_%6jDbSmw)EVYV7A$&;cb(=C zjqYBlUpVUm6kO@r4WzrYzs~17X}~+8e#R1{-Hkwx;_)Rt)|};vOK3pe;SRJDq;nCUhqOObCP?ukjy^rDmsh%7=RkHe^jigv%M z+yJ(0`Jlo>haG!9q0QDrOCVI{E9qIe)PwvhmnzG^qN#cO6Km56qZ$iCGChkGY~bBn zq^)tlyT?=!xyNKrp$~2A7h=6{D8>;-A{bZfB0erVs3@JXMBfK5KU*wnhQvEj@%hKC zyk9o;eS5`DAyHZXr3fpEnE#V+oFV@8@5NeSp zAB=CTBzK8-XlRt(W_PDm1?d^PDBdQ}*=aHMY15Vcj5W;4*F48y<8Qr7mI=uMcoTzj?K`tC6@<&RBf|<@nh*rO5}UC&z-fm7=B`e%EE!XE zI{QwcvS@t7-PP+ZQpZE_*Ad?19?-q434-wSY{CVL!U1EfkJoxmn4kOF@Roit4ZRY8 znfo4g%d73&F%MW%fQNCE4Pij_ucNGoS|qIZWUHV3RS z0&~ki1BTu$3RF})qN2fP7O#K8fV3>isE%T10v8i(-AJqlS@!#&9DDhrx@SBVQ&&?u zFV0oZ)XJvjqx^z;>3l+*MN48$0tmd=y`u??;TIHw2&F*451Em>5c!LHM;Ig^uW6gQ z0Fy#DLS;1e;ity`)ynCkC~7B-YQJ>H)URJ!_g zGH@B7O#~KKjZ^Jq1RhBV+4Sr3z1F;O`MRlqa09t}(>R+y!@7l%2;NBE@=xXIZ^`8gf!7fIlJf!lIJp$$aoQx2YzXS)R8{dLL4cgm#Al24+E))SdB+~!&QW{2 zda(8g)3q`=yZrJ?$36W@A71RvMyTR&fa zEO_v*;al*fKP?L_l6HRbFiz5c0tRXS4j4=X0E1ClI3_^Z7-b@xJ0TL0!OYwFKowd= z#^~=(gZO4KsI<%(P)4IeuoHyOZ?iBHzSs2b~*jeJzr z58B|7rphF0r_TFjd2JIS`dQ>1sx<6!n)N?g4joN<++g1FAo>75h^p-f=eXu~G;X+d zFk2zz86U1)yLrYnr%i;~ieO%y7b_3MGQVaxue+W~Q}LFe`6^Mbot=51W>Q+|3;wD7 zEyba#hO0C`w3m;Fk}0qnAXB>i%u-=D7VlF71OVVPc%LC=n_zH;bS*LnoOqCM1O$Ul zck{x-okNsOlupblRCd~C(Ey>7e;@4cMS#Q%c1(=SG$ zY^ihZK3d_$ydNCMHCywJOB`9U^4w=P3Le4aT5Jlwy<+{wG?bFj5Eng~pKjW^-|Snq%qPtPbD zT(B)Fpw*wZz77obT@{O2$RmB{<8O-ftzLU5R(Kyw0Ors#Wkp5#tj&4tX&?*zU?`d& zexD7LXB0ahhM#R7jEqGRu_^&`!@`P-SbVT*$az&iv)%u9Eesh zBSw8g?2@C2tWR@=Xq(eM=+H#6v1E_aTtZz5(|J27~eesvEE@ z+$uDu`I(BXYeov-HA7TAKD^ex^VImES-|LH#QD@b$}YKj=SVmQD2!p}K)SAhT5d;C zwBQtuMP5ut&J^WK>wJHB6AeioK^3iiCDrlBsx!_S(X!-Ydy21ba(p0HizMB(rd5h{ z4r*I!IIR?7uvOV#sEymbrxZOrl5KA~vpn6Tc{o3L7U=zbSa54IeRspjK)H`JH>QEl zoO{Dnw7C$~P{fUWW|0xu%{k$sL~*EZ96HQuz}uD3B|zi~AMu4%Yw|4% zQGRu&>W^8uG^>vZ|u9R%S`Z zYqOJl#B^ec#^F%a?L!}=Y4VOE{ps#jA$ee!bBV6d|5 z)6|`uQ-IEeY((w)UjZwO*UyF&##>ug*hm!5e1HSQWV1Ly;~4 zuj1vZaBQH3`G%>rEIB1*f~>4hQg+6Ty8&>qvxRxGfiWwx2SadWZS6x7Fnrm9GbsC8H1sso`(@yyVST^2|N^3(xJUTfxUtDA-U6R{^ax7 zpv3{hkgv00Q77?%L6YEA0eAf7?#-F%BG?`qef-u^YH@iymBpGv?a1kmd7Qi}-udx) zquWq?Vm}Fon-If3^6+>wa0SSR+#_dT5YRJ4^R86Kx?zU!zJc0MvAqFYQ~xnjRLT8E zV>gcjtEUuh+-3K1cpB6dD|OcGR!mH|M6{QGyop8Fjyxi|aGy@U!JHO*+AG3Vc(-k# z)OWvl_oKh3_Na%!G>5$8UKECFQ>!K)KWKaAN{kQ+jETX7{t;XL=Cb^++5`;%@i;AU zt9KNwccmhdMXXahzsJj9{j&;%g$ofxwaW_5i;{cKJ{dx+77s-y2WvK`zja711cm2R zMps|M_3-CW^Bj2H{)U;;k9UyCvbeS!;{I8ge2>ewQ5vsB1R*z&>s2&`m+Bc_9-6Oo z6@eyQo47N5B%ET=)yYo2AiEb|;8hmwXVyji$zz?~mQPM(s>6T$^Mo@bnz@Mef23pr2}G1-2ddu@As2N>*jZ~ix@DLQ!)k}W@8 zTv^n#hovPoG^kx-I$*pulVR8A>{7IZw6$nPl1f#nnN_c6X^px|DsY*C`-nx_QL$ zP_a=xI7RN`<%D`kxp+amK9iE-f$P)8Sn35DHK1X4Q;Ar3ytA`2Ysxnc9pINX;#;b| z|B?|{0omUpC+YFWC1!c|sUK3<}sFlLExY$gl>gt0CKo-6uIBO<$wIoIJ># zD;p=7sKIN*?_Rxo%mv} z9^#qsrPS3r+^=xUO%a5Ig%lSj#GVpqWUVyO@ya^AQya6g4~wfGeRZ+AWMBg@j%~a4 zk@LwvI{N+f^AqUf%Q?a`N3VLN14SzBCi0%@$bO`Eo@PU$P*1E-qDd%keBU+qm+zLy zfe84+SOtC z(E8#7v(-&KS54sz|08ue0rL;i^-*>@ae#umm8>=cU-4bNqg<^h@273nfaT@W3$H(O z0NMDDWCjhZUuHZ;AO1AH(+LqJ`-yp+5d{DM$-w6D-x$znK7~$Q0`MO4aZ;`S161*w z)5SvVqRffSnhd~BXv%1HxborR!ct$JO6pYGRWimeeQXeQHMO_LcTj_d7x_#DUeTRe zQOZ5SYr2X@pvC|!pG_oD@V%GH!1&%&^Vex368=L~AMw|?Gwx*?dceg`O>`VN=_~Y-r3xcAmtAqodXp-*ekeCaVT?^`<6Xji@B&MeZ zu2X36+Gyb)L)D?DK)(mTu>K$4b3c)i{KPfE9jWX`S>6?TD!|*_!TkYGmcK7PaWQ9&FG+g8@Q8(F4HAmxWM!ikSS9mlxg!T+OOUE zQ$EvqfB7fx^+22mpjSTpJH3)0pjXlsqJGjV$J!45sgV4qFa4f8_jKVJDrS&-ec{6Y z#n=7w&-jy?={VH>i<$_H>rcal zOMf?9fB{}-rFbB+JDq$-j7({}~Qno1q@(Ke|!qejRv@ zQ+X0h{s>tZpyT@=$?5*#loUw)%oSn@&dzLqlqrDi>M!o#zld4VfFL6uNB%#hwtv|o zIJkW4|Cp9{V4V>fR!{KOog?e}h#2i>5qK)f{~{ z^ZO@t*Z=#Mf093|ZU5lCCjJfQ{V)0w|5nQOCvy8w@cASL{zqOu_n*qk|9dh1(31T3 zV*K}H{B@1$zbE5==VUy#AVF>=5-+;jbyWZ8g*M>~6|P(fMy4YmEWL~hv!0K*8k~ zH~V8YU1cF05o`O|tXePMOQS5DYd81_X|w+I5f=WRoUi|_qn``ehh+pA2#`d6NknSG;{UrS)=S@P@; zS;pErwdd9e6uY%P1yMs=)eEZTC9F@d}3A@Ty zdFo+E!_*cfNMhFk0s&R-@5y^fC1kIt2>q&*nh%;wBBQ5{8Kh_&73+t`%zCqoWz{5U zHjAhg8yAYydUn&NqHHKLexo=&ZN>)RbUzaS!MEfKAmDMlHWYmR@t<(8CV~IK!}#~b zyM4+L?9O5uZx5npJNJH5A+tf*{jX{ry5kb z&v|Qn&i#zq?8qO#c~uR`z1!E*lLNE9QsGV$&KtXbvJdNau>#-v)Ru^8fa_iNLt*Y9F*h@;)2Z2L{cNf}?Gb3xNJv#5t zG=o1yL=dspvL(=1^5*{<;AV!}7|eIgt>w>!WePKnTC&G@&cGhBh2*+rO0P0UL_At~ zlWcW782^mo8NC8^)E{hD9H3o9`vT{Tm~-}82EZo|JYBs*sHbtODHLZWZ%kQFqBYD&A*+!>0aHcp7-?S;NdC28jFlI zq0!l)zMREW4V5W7E6OL$DcUck)gr{sY_ zk9x-uV&#}`#1%rrUOx{R|GF1Kp;uYu+T$E!yO|&(j*H9&`emCb~C`pb4e@mb^VA%W4uLk79@Jk1V z?E+04;D*)xpS)q)K$->hGeeLCCDH?Kws17;J}lK0>-E2?wS+lFRA|R2D=V|}XVc@vv+vv^Am}ByjE`$c5V^YG38DR+ zb5|ZDFS4nuHRyjJoTjBU88jn#>dv7&%dVCRePhEsu`Ln2RS!-%;YpFTEyY7IOAolk zw=9EIN>-Uj9~+h0AQ&}R@RyX7mduUym|cIF1Yz;G#7Yy5IwAqK>^IyK%7*e*TzZMF zc?0d=m5A85^Zt-gy%L|;^W^C~JtMiNIH`3`1QuhoGS}n4U{^Nc2RM>*O(GiD1AJU4 zOBi}@o%2}EWF4_v!6Y8j|3)&hA&In6T5sg&W)hxtxNQ+jT(6pq=NK->3B|Yr3y0kk zpvFt={fz=g0sC9g7ko{@S%aSrSVlcWK%@_tBeI>UV3vqY$zO2E$;~a+%Do#wNFrKN z)Gb?q^4B2B&$rTif)*Ec9F2Vp54yARtpl+-$Z54F)7LkY9U6{fm*7yQ1J5x0yFK#X z^Z@+pcn5cgabCZXGO8BOK#V;s3UXk}m;`0MW&AYp6)}2LZ0122a+hunvG$vu+i#Ea z_UtJJT60DS6Ncqu=~V*DM?d89|Cg@Y2RqO=XE+BOMYn?ZR)XtmcuFXSeCcY&;)r+T zvT}qC&1#Bfzk9v+)rE=`6#k^qxmP1z$U3KwK)ypWa*2c^&SiLKIH8DbU4?^)Fn^$_ zm947VFg{aTR?@rhS9oBPCQ<=coQ%RPpw<|aQ^lii_bJC4Je^NP&C49vE%ZssWx)Eh zI7uARRoL&_SHu^WKvx7z^JUGu;lj>-JuN#s34P97i7Ni_a(hJy zOkNuW9Tq{aBDT6egG<{$Em}kUx^59YdXy85H69axt>Hd3J-iOT#%fTIk*PA>2nNdy zl||hBR}-7=9|QS+LwM@0;cEnmhqa})A}6tZjB$H!89#0YCsvJ@%Rj=clW1&Bcm?+8 zXis(nuIT*qtG5y;=hqU&D@)gx%VFpKHbbd8%4N?LPSa-#ltYilJ~F2QqhmM+N);vz zCn(5~CTf4(R_LTq?RYb5HtO}(0XD5^>^(8g<{#4j4R_r%md+xBi(`$ zv72U|sJwDVe|I)e?)xo;5KUx*i$tz}phT(l9bq0=)DIg}N!Qz2eQgF_A6I(EwJE>I zV5QV67xd4qcXsbyMBN14Nk~i_k!G6Fd`ow}eUhtD>SZ}vC|J+Abeavgt)5GzwpGk| zy_dPP53}1YR*{6t*?jfe#TxBK(sv>&&x9L%1f7|5dp!U{UXcZIhSCl!YD;Iex*v8V z0_oTQEbThk3RXiC8l%%2-T!%-7y_@J zwc>yHMEu$7VTE7bn<(D~UCf%JzL3BC;{(zJwrG4F9U8rI`@6AbckPD!;80swXUm(! zTSqqC$ER!-*I;F(M^Uyfu@yccw{O2LVq?uX;l)Qm_06>c`J{h?Aa;QBR$96}I$VxWrh%I}H5Tv>bJCIa~T5PN*)3-JX z`eyTtEbV30{BVBjEwzpBeOc^ocrqdm?yui}5!waJL{ZG{%7HAmtf}4=YLD({Y<^$6 zXSeN~%OzIAGqK$}Rk0W%%VfdE!GZYr>0`%=)DH9FCx^M}$Tcnli0O=IZgPe;yY=?% zL@52s;0b-;%1 zxh-1ML=E$h5w`cT%mPA?-w8O*u3gNz_Qd`eZ#7POZN@!2dq1+b_j2RQk2?t_&z?S2 z0^p-U=V35gQN;?1O}EPv(^|VhzovsG6>%MBa@@URZlC%o zF|M%dLJgclid!u$$nVeK9v9|w%Hga0b>^H|`zh~S8OMN2tIm<=PWL_gNi9-(jrF>> z%!ZeTG<=B9r37w~MZhqK-NfIcVmm=5KggDKD|w;k;itH4;;6wa_6AP+H6(*!BIPX! zA+h&stpOzxmzsgn z@s9s76>k%(z!B-Fa1h9or$BdEm1hu%>R(V`e<)70T5zwzCSF0F3UudZu0f(|Uh+wy zmQLhCd^en=Ik1;Or^TEmgtDMGm25gy1Hu5~owF=0n zHsX?Z8y_$lsAl^+9l_YFskyQ+o@1qA7ynd4D{d*w(>eBUn_}CPT9;{~KCxJ}YonvY zm72wZ>O<^sl=*6C$H>Av>XFaplwfaxEuHR_k_r3GnQbTO)%^Ph*M35aDD3F&Jmh%C zJ=gXCVYO?w*LFmM+i~3&4DkN(B9qIw4dDb#zEF-&qW7 zGyJN@N^XV}GU%K%nsJHxFi}!cj*ant!SKeYY*xqN^XtovU9`AongR(FBd${5DTBFT zd*}q`j=1>Dp!Z!-c*NFJ%t{ke{L}N5VfZiKb>e&{Q;A;@y4yM)5Z@pk0M|`Yn#x8o zs{c>dDoWU13NZ1+0cNN&!r_=FEYj`=Q(Ax{>jhA$WpV<8*)ru)XZ?H$d9xQ+%{?!j2x{tWz786wEJbv<5IkQwRjQv;yw@#RQ;_e{$c^2w2b@R ziQR0ui6Ty$4_wh7{et1ybQ`@BnDDDWlyQU`cIDI>L38%QQF?CV_*kONCrAj9{n=`& zttwghtkNG89zPovG74Bd6RsLvENH?9?16FXZKa=nm+E(=Q>&f^N>S0nuDn_!*4Vii zT6X@!B)numTM%P)tm@uw22ov$p1n@NQ* z{`^>`8%yw?G^-CBtow6Eykjxi1x>T%0PScXrN(xk)EU}b@3`>~DE8a8PjHisT^C^) z!xkU*dAC{VtqAnh@#D_!sdVt03WY}vqp_a$0f1iM18X<3=dxjkDTmYV(WMS`AVi z^5isanQUk8OMG*=eQyWGYgpInb!TBgQmU=d&D4t(TiE)XT5ErDkxgt0ckcW~_4d6k zp@QXcZk^Qr=9F*W4asOB&AEP1bvYHgxx5FSHd7zBx)d0osa)*rn7?d%4Q-Cv#wZZ2tQ6!()z zTC?rBZHxbHY~1Dy^Z7v-Gap}sK%%o`b74WPvgdJx$dHf_=8xAv+~7PGs6cbSBWeDz zor$m?%I}X2$6!Q1dHAg)uqNE9q)f}KFl&xmxZHoZHJ<%=-eoX<_qir}*h8CXri3l zzG-OW-M=-77yms?;>L%Z#TgDyk*v1N^;=@DHhsNNV59-(npGiz*Y|PPM>V$+;Owxo zHt-8vt27v33BI=6{>7ZivM}5I9AO6z$^#y-SZlC!7%>nEDixf&BP~;XM?TRxjq46O z4|{G*p>wV`e14gJDqfMGsJv;Opk%){E;^s6`Oj&=7f(Iy;NIL@%OvL20@u=eA-=W3 zAVvAH_>E}u7at17sA>j$u8md3tA_VB)iTnWa%ht|=;Rfc&&L?j%6HeLjk`y~P^VH6 zlP(@5)$u+LjBtR?hD7}O%?pTuqjk!cDEB#Q7{nY?sJJ{)^5yvKp44N z6#a>#)KJ?j=%cmH*K!nO!jf zOyppzvJ`;ceZvyo!(Pl)O%DpG&9D8+GG65SPpW9<$BzS9+{FK{ZI2b zt7;ufS;o^pfp%_!D4czV;Aj2BT9!w<@o4Xd39DAc0Y*yX64?3(MD}FaaF%+qSa?_4 z0gt?#+^+#JTs&u6`lO>q$T8JEspJB;V%yR9bK{fiimtIDqiWFcfpv>o!*)RKYe1|g z^C=4lHYmFqL_)&rT$q2%YJt?w&JS9nfamv)p1)j=#ullSQc?7p`$rvjXW@VGqKCec z(vrIU>b;Kox#ha>5p;YVZ!6^Tl3_yq7E088QYuvf%e&ClTyF;!6AN}~TyjH{H;6jS z$)Xl~?%{RSClqr&{3D^)ii!Vsr}s2~)i&XBV>d>xXfu&J6Af=*=$tsYqCO@gb^I;p zt~-B&-5!+`&H9?@fAJ#6m`oAUzbvgtwjDg}^oqMVje?>vhtR0=MXqCbA`AR6O$S__ zhJp=^X@FV0ZOWugS;$I;B_=b*&4t7uw};p z&^>|3KZoctT$fgkC>1}rwc^`ca=e{y&jZGHAS$nDP*eg_%`%;#hu zcpo44$yUyWW2$%!7{|0p@d+LeD#bGjY`KZijFRtn~??Q|gy-L>LwxZ6H zg=2f)WnOz%PDR&v_f~llp&7n4a4@Qbn2#z~t0zXG5m#rf!*3>8J@mzMyI4b@;O*Lm zZN{dfKLGDtE^S#$J4kNlzWsHCx>?bA*3y5gw9t#0s6y^t{6=0CW>#fN&fM)J_1dGG zpnu{?i+q=`fl@v=i_XR$f84RG*{z_l@DesOQ(U6ffCA#Jpmnlq*%dKv|53~NuoCm~ z)vH@Te239Yt3Qe7-U1Lp^V4=0eYB|*3^{+KQ9qeL;voCc6dLa!*zCT}qpa%iGMn~$ zcdA@4;_wWpSn04cx2KG{=Xt1ugBxTd5fZyAGq_bBD70G2<++$f9Y*(Sb9=oqIz|L_nlpB9i2QqJG>5a z^}PRyCP0)ZHk+3yVK}k=oz$0nx;x*kwR2d+gVJZMcl!~)dQ>uAE7Yen{Ku4gg`K4f zx2G#^W->tb%-Nfkb|)qGSg9)xu^cg!6#G5y=86_Ho{2b8LE%sC=T}}EKdvpKf_L>9 ztEeCx8`FpzqYh7;3**lhODyWzbJ+cUNmGzc$zh@x4pToze9?>}sX=k)3_PwWjz#S! z+8`OZXdriczjbA>eaKY_?P!wm23Qm^WLB;dGlO<2Tfb-GuKbD%a}?Ir*2dNxn;ZSO zw|=pGksX`*CY20{8}!q(%@C=zQY6C8AZ72}3&4*+m6V?JCq)%eDmpwu8M@orTSG5K z8H!flZ!eHeVoX5NyR)rP?bV`M^B=JkCd)H%%+-dX5qsX^A>)p+^3#{>o=c+ftyZ@Z zsG9mh^o%IAZ{*QV|40DbgIU*U zbsq~MG6AG3jRS^3LXYCwSTMr8>I#s?@64?aSK-GARZ3cY_~+~|ndvGFjCL-W}p!BXt-cdA@m?&wgPJTATM$SBWv! zf(uwkMqS$?w|?g6YY1joTgm}Y&!YkQ2gl0^JcgQmJ3ykz9zJCqo-eQGT^Mf9i(}>hgi>$4 zb(-$g5e`+Nm=_xRVX9_`Laa}@ZWO;!j7pngzrn?4`PYyIv4sxzmiOyt9t&^J*J_ML z$6)386D?NXKHDH<4Lh3gXvfW~TTwa-7b{BQMzbSFhkL`fNQQKd7_V5tbLfxbMN>&K zb5|Aiv~F`vCw}usg)}j8MFVeKcP-4cr+qt19!SeB0t&w`<+VKi^7r$Z*VHYBj02zA2{!tp&AEwv@qJ z=Qfb^rY`%rHITg58juQmhj~Xzmh}p?eCM^D9EwCl)Hn-&L}qg}d9Q^P^2LKbzx30? z;@vSR+=OY5M!}H?&Z2GcO;gaLhscB?&9AJ4L7@9JJ)U3$R7%7)^PgDk zMHIK$(veIjAI@mQJ5RcXJaPJP2Rlb8P} z8rQe3FGmAU=U+uN227L)AK!xc0|PX>LBK##rks=Qd{h2qvK0SJoq~X1bU&^weZMNg zizSfy#V;ksArnswh-C!Y_oe4uA&}fM3_cCkn!ir&UbN3}+cM<9k49>Y6@R)vx(LU= z22u@^o1<~PWhv+sxtDR|tU>3G1NoQim90mBOVKX)_2Yz&2L$8E-_TAmps#loFV~&7Q$(&p`IxC8|m(S=l$mmWz+7+NRgo)tgSXE{(yD`myg|p0(x3&^$X=QN9*2 zn%L_3)@U`9=$&gLle7DLlNC9YluCl4Hs^QHX5Y3agY#wva;0hN>Gi|)y`q(sElo?g z2G^by3(`o0|9X&u_-xVvPMMvRIr{KU4ttJRM!RzLoNV#8&wKD^@*>h73>$qY^00Zw zlxWSN`pya^ogdx%chll^2GB~L`q8`>n7lTSqWI}-K`eDI zP7#qAvE~kK* zF}0uMKaMW!EAtu}{0dh5y2cva_L5E!vrere$7b1CDA$#DetXw36PMpyO#mk5#c>`0 zJkq^B_~1$#(=7vZ+Gc1Y61d`+1PzmSrV0tt+HtlTP@=(eZ&JsZmMC@l-$|jFK}3qF zU%rxn&k>Vl^Kzo5-nJnHl~iFL*A|7unU7vIzOJyP%lZPe$6sH3J$>!0Js{Fd zC|FI`Bpm*TDX_Q`ANh2hy_Yw&>F(DlQd_+aerHGpy9LFoPL2WJ3;F3-_rBy;?D$T- zlrWj?fRC2+1_9*f@{j-wI#vmO+o$|>L{?<|ZqGQQH^%`u@ z-SRH#Ty&M)LY;ULd^V7b{G>=MbJV41rv(2fn^H(^K03DDVI%$?f1&z87rQ@qIFsnf z(ffy~dsWz+Hc7yOZsUlzTbBb?Q$ig1wq!5Cq^3*wj<0E7tIA}6?Rg80J6VqfB|8`2 z$0;Xb{3s8k4ZA*-cU)HcdjjrhaxEstddm&Ie6MKgpf{Z``}Le6@yYPjKr;EW$~o`; zvxjzZYpb}o`}|o;eb3yNi&f3K4oRLf75hIxw^=!1Jb5Z1&b_;-x3~`Px#jU2F4_fI z66aMOw*7Qx94V11`~>{ST+pDKb*snk6HllN>*Q3PYv84QHM1$b)*y#!;{NZbDO4>; zH6L!(LOelxxUFs3Pt=}grT!)8X-rpZKN83fCvPlh;TaE%yJXrUr`HCpbpY|a81gq) z^gpKD=bMSmw37Nb1z8D(g}_MrzTZ-zW4d9O@YieK%#G8bS)C-b~%RLN=a zRUtEVUF}sh@y_2~y?IT3puuDF4={4ljpIMT%_m z-0RmI3H*Imn-FT2n0H)##nX$And}!S$uf}~m)q}WN3s{A*PJ(h684E@~ z@`j`#xSL#ZJQwA(~nWZgAARs7CbjD3tTJcN2X@C)wXB?V+p?rinZs- zq2{@aeQLh4YeD1*rAPA=?K6510byO4Or^B8mty~A6s+uSy~A|Z2&hsk3;;wMHJzk# zZY*3X&{gq?Z>H_p4sbdb5e7TX)ItTKaH-rzLWKa%EpoTi?O@ez*u(P9pB!?@Q8~!JORQhtjVz))g_fK|rf|L*N=MnO`Wuk0(9O8dc1ZL#^OJWDEykwZb#{z}H{% z{!Y?sa}Tj=`GQUxtQbpae|V~;>4msZXa8GDA#lnxF{^ix_dZliG0Y)gh$&(F5ggAN zNA=J!Q!2Kdap{96^8U`OK8cn9@z%DmVG%kU(k=F~N1`pt#) zdi!iu(AEbB`ZsN?V=K>Ijkr?GS`l{EN{66HBKRlREtdq`=V9@6R`irshwG+B!D`y_ zLwAD}zHv>bzn#gD1w1LmQlGr_$qzi%Ph*-;E75k-kz^WZBzkWk&k?rpb1|;@hHqxE zeHBQ%gGhSq=$z&NF^}@$TaaFMiheDM=OU_Qe-}3s*c{1GvyfP;?6QNem4{_Sjp`ia z3U+C9j`megeVD2*R}r^yTLdv}Pfj9t zTJZ_<&iRko>Y$S)Y0==`hxGDYMLLSX zcw<478W7pn)Hbq(W~`qvUkIuAq*&jA&7qw*oM z>bryV4QOnM!41>Ly}(xsyG$+jiMUSxS}~cuB-F3YAa4Ulvh6~W2Uf({Oa2aSs^B;^ zXq@s>W)!mShXp6F;!-V#7!MPwOq{*5gmE&1LPD#EaGsg$<2i7KhzW4kZqN zO5)T@V@lYJ6*%5H1PzbhQvk6gE>_C=VDBDXk7^?v^$u&>wmero={rxofZQ<8!4g-u zJBL9Oy{Dv&sOP|z(Kex@2&EEvViphtKIrgvHfiI=wh+>v2 z?qkc`Pia$Ji>)ohTWy4MTO@wyZsPuZh_%i0j?75k=S6qY%Thvvd z24luV?yb5%*iyVnRg6ql<4^9?RxeY1n(+`6DTl^_95~m6osBHdofO*Z>-pE^)-!iT@sYbKp8=RS+PYV)2?i?p5AOZvio6m(y4 z$3YK_&~pO6jH%hMmb0#Pa&^GKg;k1Qt1Ero`1bdLT}r-pP_0U+)H>vI%hg24?o@j1 z!3f?DNb#(3`7X51s7o4YWjj>w7rGxIuIV_vtfs7zm+1F{+56AVzVf7~HWEeRayYAXm>R4JSTgi{B)H91| zGs-$WbTp6ZR(Cm&B$V%fF-`GkXkXp8ULPI0_T?zqE?d`F8h%84Ba;mqPS%f8v>K{E zI>GvF^^eHO_lT@%^Vaxh_8E_7-TZdY&G$}|IR4>Sfi6Qy5?KA`;WrndyQ_<1qVoX+ zd+H5+lyUa$iX27ix`aptv|PK?WtpHY{^t64ew7_y`}X~d?W;db4zPV03a@0r>M11= z@^kU-QI?AOxSEDFu5*K>RBPd?QQFq7Gf}B>||u z0Q&@>`qmChc)r~{RN*c7aOd*K`}wWo;dJR#BG{F1WkHuM9HH6n{owwNR z-weGtqEWA3H}_!LJc?dioZ?TvaI%#UhjgL7_OQ&emB=#?MHH=6`I6Gqpm+<)29Ma_ z!xE_98&v`fk0L4*t1^c3*rN5GJz-p=iA#O$pMlc$7%Lm(+JZPyyw*GT_QbJoW_ZElr~JEISQ@Va)JyH;8WBnK;iQrxVe~+tSj?Zm1fca+1*%vgAU(&S6HFZTK)Rmc&v5C=1xpEJ#b1+NEUqX;tGg) z90O)bHWHs#eAVL;R$o_&2je9^4T;J8!kNz6R<9NIm1+Xk3u` zlSqPWu12NNPDxUhNHHTM>n)|bL~*LOTYFxOCMtbq{K$SD(fP2(gwo)Z1OmkXyvguS zEX+e1L>k)OCoijkVI(m`9&4|*JfSZ{iQXagm5V=$mm_>+&fjIRd=P$Cbe9U`lFT$6 zq5|tI8bQ2Rr>Op=J8;EJmM9!+Vyil3clq0fwpmlN*=$n5CMhgyN z2U`5s=cl&YE>qjqj}CUz#RaX`0)`up-1bhdgA|xmKz;0S!tcz4`pm1Bhr+@5Hog># zNk2l{oQH6AGRgGEl(+H1cn~MY{iF$->UV8*!6Chtd*tXW0R^^0rWc_h5V*ROIp56!0xhO0sxHrmu`|x1+0ERoyWq1k@Iiem}?G7^}fmwTlAqm5i zPJeCJoLr7yvehgFF84VEHAiIs(A`CS7F7_Ov;^6ydt?-nIn`D6i1TloW(D>J_X@8C z=2)od9Zy$~c~mbChcB*yRXm(@lfU>4T?~8SO-?5iltfO`RFlVns{-%iPf^|-U&%d- z7qK`7ExIgT(2w{+^sdAopjok1?{4LhJ*YFy!un+{cpD^-<7y^-sWw_|<;5VQ*Ha-O@+h z#JsvTdPJ)9dYK5BwsKl7V7ksXxgB3=vLM%~&ZAl(+O1!t{ZrszFMR5lFc`kxj4PK1 z%nBLvfs^!lBFZslySWO{cmFA-IXZ+4NZpH($lO;Rm!tB-1I%cms2zBIJDtCSEewEVSzmfly_ z9nFp@RgM`{v$Nz*tP^V3wR`NpwGduLz@6JF#hzdt^n@d6WqSuU*+jx-hokBYb z^{AF2j23d#(29%u9>zuza_}?C?KF0Paf{p$3J@%?q@6bL@>>~Yp_-2AxQ&e-uukn8!P=Ni46PYw3E zpwXzBC zuS>ORX4UVLXH@c@g#}w}ZX2~7!ef*y)X(|7wIaq>!-qs1bl8lcB{cUpDZJ@*jr3ea zbixhJ-()OnQ<(Sr zHux3TXl-~8e*YoJn>Jfmf0m|_yyL3wJ>u~@Xk^cq*ctwXQpN)&rkoRWa|&iku_%<;=8TYl=r5G+ z+KjxlU0iCAV&$7S;++UjV^lTszAir;YGyF#-LD(rRSF?mu(rEL$|C8x`|h45B{fV0 z8j!&83Uab(Z5I2Agt-1Eq2f2GitS=OKOMuv;_R52ogceCm-9j1%Q1Jl+HetpllK1j z=G}y(K?W+Dk#)yU_i;P*_?2?hV#0Ihrg^=+XD-dO0s9|<$SaNcZUsZE4{!MKKBMEa zH1k!q$k6aaN>05#8zxotORuJMd#HIWi z!1hoyXN2i=E-*^N8ll`dW)c4qLR%eMicjTC`jp(0HNxW=^wy}`2 zAnA5`bu#CYxzs$X-AAX_`+X~Pl81cH#TB}Xv?}M~M~jC}F|?FQLWiaT=A+W0T&hiu zol)O%*PC-nXEW{mjgbidPVkXx4U{C&vORC1w9h@2NK7|g6rJ>quQ4j_wB4lLJ!e!4 zP?Q#7XA=>kEL%Cs?%~2UOO-~)1_^y0*e(CT$O4*Oa|_d9?+^$YWT@!Bq=>+qhARui1LRBrG&PZJ64yREsNxZ_Yn{bDl|^tG z^th5NGKDP%*qGEdEBS_|$4~PrDuEAlQ{g&=x~8)sKAy_XP;}oda8qYd4He%M#!VL- z6)}1T!4(^>^T}A|Ej%Q*t`oDYEgKeHq$l=f$yjLCB*<+A4TB+8S`~W2mnM%+6{S;O zo*Dj`L{XWKCVbZsDAgW})TCA8@hxSzr=i^w-Fp7#{hN)fgL;U&e;vfTw6oO=*dxFi zup=f_ySt)Ms|BEhuLZXYl_5qs!M&w1i-t{fExFP|*REqn;GWW~G<1imHX$cbyJd;L z?kg_R>+0Ywbf&+F@d@d#0hTK4H(S^T}d znJ#@f!XT2mwPD{vQmwaImhkB^$dcE6A?|VBdK`{C>3FaBYr7@v=thjc_tGNS+!bw} zjTvj6QJRJ>ppD5zV`HLpPG=5FT=k4(>gBl`5Ave2APuIMq;#IJruIDlo3*){TJq0A zd(_4GbIpH5B~= zY}bPSph%|mpu0sxKwsw-+EgB?#UxFtvBybgeyGdTx1(7T3jWfu{cL_XVH14A<+RH0 zcpTDsmA85#IjEBCq3s=m_i-2c$i=4Nt4IioIrKXz?9aC=;j0Z5g}<=`1dn6yoGeZ`HG>nmjajh7 zdk)?qArP>svnYAOVZ;J;b0Mf+R}6Zf6ru_sMB88NpPpG;?lSZ0UWs(7D77N@_!lvH z@r#O!Y^7?)y>k59^75@2(arM84*D+6%p=aE3un%)4@znS+RkNs^3Tl_1+#U97D>{E zF@xT*=j=4uZrF%>hkFt77gnx+#wp?I$b9e@L7pE1oHF-mUMFCUJ(HB1>9b{{91YK> zybss66<9!@BmV{S2WRU({DJ`-@33d#!xWq^KW(p%+9XD+S?6`K_2s1ZnFn;9^5q6>96 z@@6jq!0Pc%Tk(`(|8sai0#i4`l-7xDeKU5`9~tdGz9H(UQ@fCK97}{jshF7WwwxDa zomzhIMS6=Dd=e@{BYg$cJD5 zno;$BxLoVv6P8b9^?9kBN?U>du0-#3y`bJ@x)dpC>DB)ILoO!0l}%A1Wg`TY$`;xi z!Ra#Z)>k3oh@wX|hCtL%f#s0WQY#bmWMhuX%>AR4)myNhV{no@5z?tc9xoLbc$JZI zxSxieF@?=f4LK?|nNkGz7TF}Xx%dQy-FI{H-}`y=(M^@;?N4>Jqzd-xx+0UJw+0fO zNkc-9kBi!#GqGHpE^Zfvx(zMi+&p!ERh?}cYlmfx`W2d7Z%0EE-aU63ZME03^|_2N z8@~@bo9&hh4QQA9JQu&LsI5~xO)W1he69_A0Fm92&gaCmx@L;l+wUWW}~(Imd}&JGgy$L1T~tXJa{v%bZB z?+V;ks5p6{@hGXAo`C~My+`Pq`H75VM)QdujFC9JYwUnL7r8JC%vFPzFGmn@1@-3f zo%iIvmK!Uatb`30=;A6j+bRSXA07jZbcbD`(+RIn21kvgwmeN8D(t1*r7k`lq*#Z( zZD_u7qp8E_$svYwRTNneP*0k9BLZFR&QkqmJ6$Iz3Y`gCk%=q4Sa?%;uypCX8i81Y znP?+5lKJ>!5yq9S8|E21FYfH_vX&b=Ui~xzZUE2jEd?X@7<2z4@?>0>boE)`1G8=g zA_uo2J|3G>JFw)ZTKUiFv_WKO;S8RLOx3N*n#5n`+{Awi!s(}%Zsq;cX8*B zL?}Lt?gh*?4d!*dkdCS?$>R3S8m@q~%D#)*aI_rgGz93?{;IeV;HXo3GcRQ?q`Y#u z*OsV9w0T8{JRMmIXmi^lgf<@|TUm;FZ)p^0f<&x;>qz6Fi4lq1Cw1^af&OFZ{hMy9nE6y?B+KI+eowD5P`9TO zFQsU3sizbFVj3Zm5V<7(Iv5i3`KBfmcs)^7r4Agpxgy%BNLd60AGUQw^QENolCmJ( zr;SdUKITPFmpgN}ug1fu`tkSG>a{cVBYqcoE-8H94s@^(FIRKRR=wQMZTFNesyCS` zFUESgKSX-BULmFM2MlED*L3us7%+T5Z^xa*5z7M^os>CW`2W~@%ebiDtzTGB1OW*t z0SQ4`Lb^dI>F$>9ZiW#N5h-ElmhO^}M!J#C0feDr=mCa!e!A=Iz0bby|NWeO&a3?n z7(So5V#RlT*IL(lPRhMbGQSp2qd*T?^`}P~?&orN1^2ykJwYm+UH%|%?fvX!HJj(Y z#!A%1J=s7^L_#I%WcFUzII-!Qx`e<^h40y8gv`tCmHslv4AuD{zdc%X?z4L^^LFEj z`o1~oB<}ue1wji|s)Z>z=9JfE0dwoc4cyU=^uXj#Q1@)?^0m^EBKKGx)v4zAXtCs0 ze1TuTvfRD~9GCCfo&LS7SVLZ@}hrsz>66aKJ-c~G#Tr0+oPq;^o zqC9X&XmRDi8gD~RQkWY38=se-$cfHSX$257)B^e2Zi_LKuALE*2?|{y*MA2E+SVC3 z0D( zIlwPkcC^_tE-5e~S0h(XtIa`iivZxXUzK_aUaoEAXq8f+UON?WT)=+hOIh^x$FYQdS}5!nf;X{GL!DC`rk1=e z{d&dt$~P>(DFX^Nw~4Rzb^Yw8L_tsNopy8UH=3Rkj8VqmYgVa zI_>X`?8Z2w0zf4S=k`^xyf(BvG#2?dd*%qJXDzDb=Gl> z1M-q`78u=XX?Y)yKD(YqLHanBM$XgWrs2n|qkfa{iL347R_kgzfvpF#1qj*ra92Da$C&ej=a7P*bqpBqtJw49Y^ z!+Ag>Hlwje$$IIizlo5)Dh##yJ#I9Fi=lFyR2XrXG>nWt)3{9DaCAeE{6z%_>FGND zFnu>`NjqO%P3qmr2vqNVALWKo?8iBs)&LRkIg_!n*q-E;`$Tl$S>bpKWZD=!F8TIq zVmM*GfXSqM6Qnw(v9#~fP`Wie(z;yrma&jVCFt@r$FVuBWYZf-ad*$AjH3{ssnjfu zR+L-k;qltWeq7WFKoK$>zQ}Q0LOK_|L=X+6dFF$kP|^5dtuMSyD91v+Q#eDB-nf;* zzqZ7%z7rENui?ZT(YUy2I4mh>aJZqNdp`77*9z9RM^^ip*^go`H)k03(4h-de(M!? z)#zT!F)^9}&Ji*npCAZrsaCzW zuY=aA%}K^RSIv?v%bqUPXJFA@>%~0AT{zvjg&fVtL8>hJVS=8e4|Yno8s&iz!UlEy z>;bxFWi|d?a=Nwl^%|vWy8ZF2kdF#mR9_3re>wI`i^2VGYV5z+OVvO zV2-3DUGc>5^-mn6Lk#<+Wz>ac9y|JB9EGcA>QC$l8@v?Aem2o$G@H=yE!xoV+p4O* z4t~lSvUCtSXxuT)|iuC;vNheVTx4Ve5$6{p0EBCBcI~&CkGH&!JlVXH4?=_b`1%`GA2o|_GG~gfU z!L=0k;g#BDX6-@?+?!D;ghxmLCK#mjF5>E4WLMOBLG%@OmT`a_piCJ74GS++Er)fV zIv@%hv$eO86?(yHNBgX$_Ixexi&U{gk`R`4LSl7DbmNM;CqHuJmeo`d)xfi&#|dS; zBTv}htWd1`IOq7VJ!3(n#4dCkCB-1aGKl*pmg4Dm*rr=9dHQ7=MbvM3YNZo)oxd{h zI+kt5+$f%p>^G@37i$!{=EgglYqhc)J^d5M_!rf(S3-46Ub{LGItn&bD>s4)E6+X( z?vt3Wjlc2o9t#s{6T7*RZ=eJxL)Y>Krzju{V7d)N!$NKI;boXwv#*Ll1N zV8~npi$cRzl^7+WHkL_U&?U0*i;Y+7jjyeE;>5@J5Q?9Ds>$@)YYXOU1MICaSZoVz zE`yAPMy0k@9W!-F5Bxz++T}eCpJcbBOLO;4HyoPYMbm2!A*H6)oW?wNFAO!Xw}Ml>={d`d*% zmEUn+e{DXin7{fchVs5IapXn&Gr%c?(kl2$;?Z}o(CWw}VjuN-J~ZXz;(7}RG?6K1 zvhsqy;Y+oi?WsC?)1$*muC8sP;_Zq!-0S(QOMy$4djb^M>hH zaRA^Scx}-`TCWf$JvaW*?`M_s1zF0N4uZr}&QVdSjH&Nf|LD=I|Di@Ub%0M4;%T)J ztz6_W{HgByKY_B-?WKg;4Wguz0n)IXo*;F5ZRYd{_!9j=&xp?h2pYw}nz90sA{Pab zs>%}8B|Pb14AJAm3g)Q?N6uY+-xXZGZFK;608mwkDl zy1_5tW!+M;uzs1(rO^D)T2Jz3jKfhR+r>y$YUgp;l1*c%XhKI&uh_0zD2EsI8t zd33xP7kU=l-F&uSNC~!A`KB9i?Gc~q-mmM~%A&xg*Q7H?<&z3s+US>GJ1?uZ$X^OT zN+|IkV*4qKr;!gFWvb$Hsq+ko1_k;WOMuN^OzSB3n*&nGkczRiHmHt^e;^;;K;U3(F zBAxgo>8YvfV$+4|#3;i|W$vSvQ)E&4hOw=MO9YNT&@eN*YBiG1k`{HksLVW2%uU7i zDl9RIyC?F?0TH_vwJ+DwS{k}IFb@Lge+&h|KM5rq8M7Sy- z6HBBuTlQ(mv}&l`SepdFo7oNeta%??utk*im)Bi1tyhhX%?AAEndSm$XJVo<2 z&0?QDq)pW8_lL;!*X6SPkzwO&T@S#sqF54%6Wr^*%6dv%X1jagqx%Z0A?#H(^LBou z&RYAecc2TuoWeR!&K8&r0zvnW=HCr;L&Rt`uE%$1cnU8{%1>NOWHA*+iJF9T`ZPo* zaOnQ16u$lmcO5Afo3~p;wu-_C^i@1e~V}{PdeIpI#AO@M+~6}FSD!K>cnK73-MbRMO( zE$g(%68i=-AD{K3>$~m6wZ;O21QQ+x$|+}1ucFM9`hI&_W6y6s@1V-=eFok$D1Qgk z%s;kaLR_5JOO|N-s5lN#RBdvl!migADAQk07nlac;@^i3*XCeAlplhXD1Fae{E$CC z8etJX=Z?np8vq*R?frBTfjonatK&#mvl~^jaWc>RxFb@`AiAPQ0Git)V0Eb&I!z)I z5#NZuzz$TN#)Pr$G6CT&>+MbB6lN*e&)rT(!yLpK30)+DkNaV1UbdokV$=DUD5uNH zvr)pGy2V{7(PQM8wzjZqu&jen%RDJ>T-~RPUpc7Vs)6B#d1A%7`HdoS^P|{u2a)Fr zi~jOppVgttT89}(RBu@$@2S$lfm?UD@mlQojg=kH1Q;!J34LsxA0vSJz_d!orEs<^ zLBl#$f4hHSa?8gJzc-KLVq{mqb+D3Q_KSh@jex5qLj7)sUW;F!}L3#VjS+>KeFn>T|v7nf`+j zF{C-$)04PSGg#!!-Mzz~n@KnI5oA2E3?ag?J6;=UUQh=1=Bpx+=?E47RmHjieWzAC zM5{fG*1k23cEcJJAsTB}-q^K2wvj8!cYQQa&b20XeBm#sRs_Z=mkI)csnNuca46bu zALar~IFdZcxR(RNDUXcs_%m71ZfrkLtt%i%pLVPOE4(u6i>ou=eZmE}8 zby*y_SCNsD=#6JOHgcISPss%3}e^qc-U*g6nk#-~;3GLUfRX?Vs zFjb54P!Hi-G!+uq_~<*-gyGOZ;=qg-W9+Rsg3 z+oe#>6bs@@h4wSi_R0QD$kLT2_hhXx4i{%Z|7W4Z*SX0n*Q@aL+4`etY33~!c2hMZ zd#{dG(kUn_)OCB{V{&{WkOt2^@}yhyqYc;=q!6-*r0AyfVCg*=I75WQYP}!n{O)64 zU4Ldq{&P}nH!RSB;7#6sBcg_sbD?SaDr=`?wS`>Wfw+rtw%=*oh*+1Btto-t1(cbU)JB;^eU)wD=BRUJJHq#CxHy)1PNk6=a z(MPi(${lAd`%yZUlWq(~I+T7E8XJsYFXJn0P7_{2zKx~2Z)}&P-(r(xVEeSeyx~Lu z=YLH-<1u2RCV$chZpM+JWaC?MS8QRcr+WZV&j&GVoP7HcsT`ah#xAIw%ziAPM&^GYYBmSV3SxmOo;(vTSv%dD$LmU4W3v@8*1aX!vIQe2d9 zf&OCQ+x7yRfv}>^bdpy3ZLJZ&t3+MnU9Wu4%_5 zC-?@{2Y&5>B5i7V1aG~K{u*8Zlb2y$qV!%yS;xf<>&wpou_+5*R7Z#x?q&qoR!kIr zH8Ya<0^-64Tq#9Vi&p>SoCnvb0$;E!H9+1*9s@~$zPhCVrx5@CK89YG9!l1=T2?EB z$n_u=&~iE=Br`0?#i)_D5?cmv!v0>jD6DgHw&(Thln`6L_V=N#y6|F$;}#@01fnEp zbhZShLJpFP-EjGs{K&3#KtR3XLa3S;4zH%tF8v!%s#{I%WyiO7KUPHe;+D@`cv&u-iG}!gpIjxGS_f%4fRJihwDX=aa4X)WstIXbm zKM`?)g|QF34KzA2iEuB(XJ^vK0o*LBRT=M=68)+R)(>;+D(W2`{@4kvT;Z~F_#)seNRWLi4 zstGk*Tu_;xY=9Z|)Uyq0XX-x@MPbS(`j3UXs91+160L(BBt|hIixsm;4^7qJ7U}|d zWHR1hPPU(B)n!#Bd5lx_SPAa$WkvF-&19`WcF$fasvAy!Y!3i@MIdcDqY1K9P=^!ZIlZ>@#gv+Wz{36c6&IpC`YtabxD4Bo0_3upFu zuqi)v*_!fD|CFL?zQVqq zDPvZZl-cbUs`N$W#2`m8>#S(CKbLX*CBz~mLj4u4HkH?(S+d;FnU&iVz#EXF^Mu6o z>S;pzL3|~HS$jK*)#WKp^|bge20de8J();&{Q3|=zWVB*BWeu#noCuRZV1H-n*2>` zqS9@BFz%N0#RQQ!bk#0}(K1<3U!Jq_buc4Qb_@{_ujaZ26W4Qv?L)E$>a=g9i6Ywa z#_)3wFwWayy!0zZKw=IOvlcX~hY8e*s=dT8*H4_V8n9?Ck0#}c0Xt=y2_Z|y*P7C; z@|HmW{@JQUAJQx-i`p~-LIQ}ZQCzPe`Kz4F`jd`W%9LQ0H(vO4pHB*KvR0EhmHtXyG)zt`#!Htv-WM{ zVy$MeiX8XKvITv=As+!$Ia}Lv4vb!ZIuSwTe3_M+cR1y~=s1cS0r$ONAho#k=*hk= z5(3kmAsAzky4_WkR zROcquXB_bDOp_7RxAv-1EARruRQs=3p$1@1Jrs+egJ#Y>;)6VSH4uJto( z)=SDCh`j{dZAuRwZXxr z_F2^`+@5wmc|*lC7SWQ#qK%Vg$sT8)K30#e*nIsXrL{Lv_IAeVD>zcL9ETSb)+NIy z$0Wa9Sr?he)-Nqzw2|llL;p)T)1UMp@HyV*IO0Aj-#!6(u3Wa}TK+kJyKPry>Wun4 ziliyXPnJz&Cq><7z8?KbK3T+QE6Ay}=4|s#1^}6$)7;(;0BX%k*knv!*;S=sgSs)n zWcBj$$9K=Zj`f*_)I1d@}Vm^*-^4Wq#d{b?tB)}QBm#fNR1KB|tgb}Xm@q2aUY(4J#)^s^5(w_2l z){?#C3Jufjt*MXrrE*h%Z1z{Bw8q(MKB#kz`>wa-^5fFy`n3ivFKl{SQ?KH#u1D+( zYa|qB?aD=RB4pi)qo>kAj^=8nY9rT{+jU2oNp2vIFlnQ44H#K-gxa@zyg=7T&ZvNL zA1^%*pTz*}XTVT~Zn>$`(kq>x9KZK2MgGb=J(;VmapxT=z9Q6qj4h^oJRU{4Ba^6b zY9OEAI^EMm7eqy#EYCmfK0|UUsBJqr_tb)q*+BFVcFdo3ONOzajzd0484KM#pQ5+A!TyvGd9-0Z>di;052p|b~$x*I%RcSfm*;@_uRLP-O z<;Jaxa_`srD9pYH5Mv`ddiP>Ki>JPk*Ae$Vji5cJwg$#C&p8*3QMbs7!-Ln0~Dzgw#oAfSI zsR%$dR8#Qx(NQlL-f|>?E%hfze=8CiP*3p(6iFsA9J$LS`VZBie_bl|{JoazGr#(S z6&8!N{551WQdsmJ*{=`}s0aD`5RVqP z+_QguxhjMh3b%(=KIhRr7Au{yvQGIUaS3wMY-t413=qoBVH&A668hrZX{n+;uUF9x ze2(-W04HpHU3rZ`s0sWesE#eC2-}^&EJRKPn3?z?1Iq6H>;4F13R%8K?J z+1y3gf|X?L(_CNr$0X7jz?*w7lkCK)zXFHLHNdyiO#AD;NuK^Y?i)CBYJz)@+RaBc zI7dZ5#E*c0=N0OZ1@-5bfOwI<*C%X{{$5i(h+`(B~HX(;g-NO?&*awWMwVE^Jk(&eQz&Zs;Qa zO}qIs4d0mnm`(qUsYqbJFraIl|1MqoGYmZkv^pHVFcjD%B|DRizziBw0F>v&U zY5GE(|3+*2HwU^R4+v6=o1M&u-zH(@-((X0ynb>22h=;Sr1IY7%KEv^@0WO0~Wf=@SNngh?Wcf zdqp(!;1_hD+$mj=`)!zm|CnK3Qu_sl@&7d#{$Et>NEw*nePLBAl@|Eh09E|Q0R1g_ z{2v4KuVTGB|1m)S1#Kd?T;n8=8Z2Ni1?aF(ZU5>Q& zO)m|99?O;M4@AQ0dFslOcP7BoWpQ3TiZMX6BA*hJEL&3)2T(gWznG0JJn=+@kTGI^ zU`#hqDs@5ghf1aXdsMh0ZgRQ;hQXE7*dr+bkVj7hOfn2}Y*rh1 zX)KnhnSTl081(`8&Ye5Aw}Ipf6MvcOvYUqPtzlDdlyxf`egA{LeaaA1s`Xm zq^`}J7(YEE|8yBjp{jzXl7qpF`i{DpKyLH%J>ZRsX3)kUXG&uVR51__gKK1UKTT+D zxQWY8+c5x1S?nsOQuv+uv$4v@@UODYjI2RHVYG6XpO}Xx=eng+Sy)&n6K476vL_@B z%S<+4ckKLx2rbt)cT$8ZYAf%Tl&WeOyea#{?<7^ORa?u*&O&gjTVfFO%B~R$GddQVl9X;jN38RQajY;(uBVmKGZw((4kdIt@Fql2?%%@hg9@4bnHRSoquIH6DpM`3>~TV zysiO-x_ti8L}iWl2K+cdzkmKm%kykxbPcGh$s9zEE)+`?*Vdgh#abtx{(;9hEQYSM zt2ycn8%$h&(&?A7F_Iy{(y*biajXUvn6tHw=(-96~<@ZRHZ$n$ptYlEOG1FxwD#>44{A zv3sXCBO*CKrnmCAkri}izlm(&=c8KVW_R=J7~3eNN4(yvQKU#gw$yldO4=BqoEv># zD$Wfix-IX}LmhR1lk@K^HYSE*1NovNw38y zZhLN(zs!fMVPGHdfnRE75vpJ^qQ#=hq2#_*6KBf&m%p~rsb`ktU?eekQCpr4%7Geq zcRsH3iDC(njL2C`3Pcmt;69iqrV$hPbi-(Z=BG_HTEZx#*@Sd|68Uy<)nsGaFm2!Y ze3SG^)~()$`%me3C~8j-)s%*FZS&(pnb+N=$mp2(K!eM9&Ew2Fsy#!Kvzd|ozgHHx z&1fP8zM7~~owUi`Hju((G*Lr=bkA#|Km?@-Ic%D^u#YhlxhJw)+%OYMQixRAax4sq zIBaw?J{Z|vDc^H2LV-L4olai;fnB~;Tej8Cac}U1n_*Qn6wd}2I8V#_=MbZyGXbNQ8s!IZB3R6SCNsLvMVJ23WC`+(U zqQ(eo|IhczL5p&j67Xt$3)+sR_Fg%=S0(jH6B$Xn`bQQz%Tm7d>x!lQ|K}w=pdL8 z9g*foQ`k#JF<&D&Sby)59Ut@{(SE9$##M9sLcxC42hWjhm@yCIT`-|biBoyx!D(Td ze4Z!vwhkbR-_8hC+RX17yP+vCn~Zsfv6!gke?+B^@cLj1-02732`?oSh{spdUnfwE zO3%78{zJaz?XwZh6zw*131bkC*ncC`e-im`b41I|v!mc!D$J3d?{mW_ypd&$!%76> zRS0Zx@pFm;Tfekkti)04c5K;rLi21!T6`(pzRR(u9QD^?m5Ohpd2xmh_C(2UM7lHI zmUWatlJdPCB*-STO&wUzhP4OyZIzjtq5I*A@q6=rhzKG`TWy`Wt7=710dI3TM_yz) z6r1$-tj>g5pX`rPvc5~%6qhd|QN&x@zm~zD=%l*1K;tJ*2>&^KD!%$wIx9o|uzf#n z&?9+F;zaqN;GQ^p*Qo{-pughRzl7#;{HDr47X|W5TC6b>Cz!GT0ZKDX)NacGhIpo_ zx0ypr-u^nPqPMaGm)s|6tkivOlj}qrvp=+rhm`*d3-CAlP-ct9IOuU!FTvk@;_%|3 zK8Z5_<-MouH~jsK;kBg@@`X9<4|e%4D!zUVPAUG1|4b+H3TFLm|4MP=nT;Ga4VGa_ zwS+j_#rfejwE?4mhSykGE+cF2i%HblVakIY7cBodT%tP++Jf#dY#a&^R+GN?FE2mJ zzyAKcSKXRuP9xRLxq<*hA?87h#7&dji62stGg&=UfARQ7Bf&c|BxwW`mRl^WYhdsW zHsQ`MB+v$F_fL68f2^KuYO#7pro4?Ass2mN0$KD?&=ibjcicv^)!T9a!QzWXrT6#* zXqC6sW8g?^3S>YVgdDnjESbPzH2^YLCHk;g1MBsXK@FgXyeE^|$LfE?dIZfohWGT_=jQZc*YeZGgQxR;%%_&vQ}x{wIQ=<0>tq@$isUD*8Y3_zgG@H8%hTGmHDyBme;CNdQ)eu-nT@-J}&*=c3t1C|bOapcl} zz{M4zJ@YA>YeJGhGNucFn1Y=mstCqNa`cR41 zV!u4w6FHP)%z|b|Bl3R*0czB#>3AYuP56HN(Ok3hvPKOMbhdod;H?KAq33t2vJnJ( z)(`8}(|(vQ-+fJkknv21#hNZXc4^^jADtzNBs^;{E>}7c@S2QEn+pmiTE`&2)L+i@Pzm4ogvPE`9eR@6#U5kYbb1+GhW>+g7nN^h4{QB+L$jT3+pu(*1*1bYq4M2)tbLrb-`93_0f0mHF7fCGPcS^!T) zrQfkc15k*rHkyLoRQ{I)TNK&!VqP%oU5M2qx5I&TH-6%jhxcQIQ}=%GOc10=2>-~h z!S!EY-`6fl@HK9(*<^IZl5>{#Hal_JP|w~6FOf!-%8cP{?tR>FdQhyY?-qAE6Zcjz zx^Q!`onRIHep0bk@$pH}o58D9!hlP@?#yfLD36y*wW8&Sh0b(Z0GeT+KKU*DlriU`GjjJ!U?c zE1va&baBy0dvIn#{1^Ti$Arc*KFb59#p=btHHKGpZ+8*aMr?z zL5ik*t0JlTdN-1AFq{K!t;2rMBWpyJw~_O>tVg7U(1>WR69Mbd<1I_%W@EJ>ELcrgz3p&X$2 zyaj6|!lZvfI@$ol{ewuSl{m1ksa;Ls<`A!zQjx3i1bYQ^>CAvqlvwJXgw-J0Xk>7> zrOL`-s^c6{c60fT_T0@2^{Ow|I z&(fylH9fZj_sK=cCf*FNM~QryQY|X;+{t$j)R-qX-Ih6)M4|0AUUeNq&8QZWf}mC% z3Ny8%gY#)*-;1wpyZk;8mLj7Mhd^mVQ}qUD32#{0r*+7;J)ZBK61WKPLt?Rx@t*llrNQ}Br-q9)MKEPcJ>Y)TBwl7WH-cB!p;I#Z6+trWP zL&oz>4>D2mKKRcL=USOlA04RbKspTI2kDo1?FkNdwqF78zyRg`Rh1de@*o@@8a-F< z`@L@7`n;OzU3JF}UaLx;W`{*WqCdxe zLTMJl%I~Q@d2T=Ja%WgcX>;NW-4hHL(rHJuNH-D%B#1Q=JwM5Ph^t=r$lFIy5U1JC zQ*yjJK<5Hsd4B0_;(Y6fIyk5tDn0QDp(=U6bX|E*YD#JIbZ~^Hd4jGS{9=h#7`_M! z(Xdl!^t3O~648`pa<2IW9*Z5iZ267;B!dJ00~wrpE9NgGwY!!|j9SFS%b# zF09m(Y*4me-WA+*J%l;G=a~wQjE0 zMnfXZVV#6ee-^?EYt)2K#~qFT10OJhGF<$ zZIM_*nX%!`$oo$y*p*>8ZUjq>USc0JGD~d z^f#A_IHTT?8J}L>8d2cCDvN(0Yco^H@MzJ9(ps4=XS}FFypZt#8M+a)$aq6CwZh-(x15%ZDKjNoIL%?qAJdA<4NRCR`h ztIdgIgY}r{<{5Z&>;(4$w{6K|5-|G3Wpbp7g_TuEAG?TOUr)K92ByISAhpl?)kFRQ5PBgW)POYHH&#nc&ZM%laByCVcDerVC4#&j}XzxXqpVT+U z7961_X-SKfT!D}iYB17r|NP=2y@vFIZT3GKw23dMoSi(zD^MGCm+MoBQ*9Pz=Jp_5 z#j%c9JMCK><&n8S@k=H0nLq#l&b%wyGH^xvR235(X5Jm@kma<|riDRyA-oIq|LkLl z8@zp^lFIIO@?IVpZN0EZFPSDU4jUb}#$ULnnC9lMx^ShnmcbG@9a2)!PYsPZUTjZS=uxrj8Ng4Gjf%heb z&2FfhY|=-5;;G5#Csker<@VcQ z-m)XqyEXe^4{*aFhEoH`u7D^>N`Vg#aIclaK|e>tGA#yv_$Gxk6sTp20!YprR0Jk1 zD}5^q;5R2OG=*(K;Ia;fIRMIROeN}an8~EdQA-?;>I^fcEO&E+GjPq{$@8R&^hH)s3Znaq#iYYAv7o^?=D(~G=^S(%z<94^i- z6ZW(q6#SIryV__%cC(FkXI2a+e!yIOJDyEPxfZ(rn>KoZY&@o<;Ct@`zxP0m3m*tL+h>TlGiMmf5 zpGVeb6tye$RfZ$2^PRQHXIk(@{WF8Cog}_k@4Y5aT6Z_Ms(mx2te^0*6Y@adAn(U= z3uWH4zI%~RVMJu|dK^wZyFjFIUFWCcw09yLh^>9gn&lr`O-8BdR0JQ8_jw3i8XpwPm_A{C{?A3q34NeyMpS|n#6iv*o+*eueXRAx;$!ih`75na^ut3 z`YqLEDQ};=sW#u{`XZp~xX3X^aLU|a$mV;-3rchbA9!J3Q<0G6;*Lu-l^d4avP=fp z4dK5(G7$hfjZzxUz23y;8>{CntZmC_B98hw3&%A<^trp(_RmZ`o^CCCt_A-`bPI4T zA}lHjWfs}eOMxdR*jMmFnYJ%=5$ckiFNH79xmHfX*o7lpycTQ?y3ErveiD(4N3nOc zs(ai9u&}ar)w@+F6I zv-L1MUGa#1)p*jdg)}$SL`qy1a((ajXW|D136deRR=70VQBf*dlF`h&hRb7~jL9d> zDWX)mANk!=pOA-*E^GrC{(9%_#Q3zejlE?-|SZ%QXICm;q2OZl{7HI zPFPkCv}v8})~x8#G#cgYBJWys1;71@oAspe`&SG8xw;3r0cjQ_A0y=3zjVmpSrdhb zBMr=n=2s+Zh4j4kLzmYTyFjK(f!X{NL?Juqh*z25V2L;1FLZvv;JI)8lt$cdNZ1wg#_mz-HrXve>799jOWMO57N8?v zjN@ful`2BN$fxJ&GrPpzh3IW1=lvPSlWivwN@Tr@IPV8Z(Z6Ax$`cpI`n&46j&^@1_`OoM@vL>Dt@7tP`!P< zAINpfPuE?sG5+-ap81EDiuZY)HrJ!J5IZI>*|^X|`*@o=m&!zgGHxP9Lp;_wKMY$c z?S>2NylJCOZ_U4})tY;^_}i7Y0dM!nOjn4Gl$${dYlR;-VUY0;D(ti_4HUrc#V?b?(By2 z$h?0u$1a2K!z&MbE^e|cUsv0{2T}}qP+l7OM#a+T{H51Y0^cVO)9VDqEwfRcm>!Om zJ=WJW2XRkFJmA>N8@@Ds7l+CIw>e5!d%%;CCELo=E8Khgp5N*Lf*sX%qC_Y$JoW040L6kl2U9}IJKXx1!WS=ky;)v1jVwO0Tt4VKU29pf zyFGK|PiJVm+!VO10iLG1Az)BwI>}Qxd7_oJan&c0hHZP$aF$fUvH|+Gm;KU&Lp>$u zE?bo9A{8vLdc!D%Dpb?Y16(pzyJ6O%e0VKKf05*y>~1UjWv}&owffFS3xSc-(#AQx zEBoZJ=y`1`2Okh68S!)We6X>y-35&RgR7oI1w%(TPf|h)Ef+d^Z&GyNSkP$FeV%i! z^Ye%=zMu8=3!qVD_pSnt5u_-@1A--c=!iO*gwNa8hw`&R`=k6!zQ7;YXkZ0JBZ z##EH#ni#uxVTeqEAusz2K{Z{!Df@rOCKbq_P2D1?@|rH=AAe77P3RaHIB6w~{EXCo z@ZH0Ja$@4d?ZK+eRm+NU)9rT#>#>{{>(}S3qKP+5wGK=uL;+ zEHh0$9D{wt((U_OUI!jV;CVbg%G?^8`P!QAK5_Mzgp5o~M2;UB zMmlL&MF^(W=$r>c&~AZ=Xq>fd=?6Q!m;oa0%N~yHE~$pcxj1>%Ztv}iQ81pIa|G7W zeH2Z3+aaUWMt6*nY~d6_RL?b6k8J0)fBdHOmDKr;5n)whbkr6Sm~0OSM}GFIijGEj z{8Po{e3wWCTCYBsq5K0&1V$+@2)>NW4Q}wuc#;52XxNFM zzf0Mc1oPir@VfVOh%8$^M606t4h5AEe#FNP29C^9hNC*Lj5CvvW_(Ak3%Pl4L{Cev zH7dPRJk;!8aB`gY5fgM`28K(d4LBU;^_1FhpqUn`pG{k(wY z8Rwlu)yIBF)|0FG0|6%G%-TJ+3z%kzcEm6K+BUw(^DY4Ver1;;fAQA`+657JuQ4NW z!9A`07Z4V+YW8bBGyz*&DJ^B`xF;~xhFeRK>j(`ct7@s z*zZqytkl^9Pp5}jH}-BLeaHO5Gh^;c}EbGfyUqT{B7)(mOXdF!D-h}Ucm zg1h}RQd+fu@OyLH3+36)qgOcKk&^;fD5;7rSR5h0_wt^&O(44`3pw(q(zBSaIrW|U zp8yh(ln`7;FDK5gcixwYYGHdzdW-g)6>2r14GiEkPsryTaY@9}Jq?^`xI@8`QE zg(nNFtd$$)_j##gc{Ia+F+^+gEVnO~5fq2sDQ|V%LJ=qM^0ODt6miH;fzqBd=FYl# z+jk(3ykTeaVr0*&WA}W3XGL>XqO^{gN?g$|4f;DH!po}xLn8__g=n$Rs2 zVL-MP(9}{4ro%HD7a?x?L9q9Zc}hv&a{FBE4rHMmTXVPvjK?uM5st-@Q2f8+vqaHE zZ(wfEZyW^fQ4}6>Y_=w-*65GJQ;NGCl{HSy5g4o?aQ&ZLokDW+4!{GP#R@eGQ zRsaHQGAMRV4jYZlxVEkBLgma3TcQ6LTcOrw9CK&dX~HvCtR>(auL(K4b16)v5U}^dds+YD)AnDw%PE?_XoFJ z^}|&XM4z;oT|8Qj0~AFv0xA4xm^fuZodc?wUx%#D)*SRk;X_=H93nG+LY8-z)L_Su zY`n&wez5NGuL79zdt`G25#?Z|*tPZbpZ4zDN6HRw?V51*Jx*|g-FjZ|r)+$fs8(=? zFC;HZ9*enJS@qE}WZ_F4&_xvz1&{2{@WwuI^w_VSeS!aa=7#0yk#ed%W`#?&yWwTBD~(+Sav2=89HKSkG7KJ@zkSbNK$IHPS_I}ix&1PSi$?(ULc z0fIY(;7+5#T^b9X;2zvv8+Uhi4NlXyv-i1Gci(-^SLb|ntC}kM4@JE)*IZ*fV=iHP z7hYa0A$OVFG8MRC90u6;0-iOk<~LXqo1fBAnm=Y&XdA1qudwa|c7Y!|yQ-p6DX6Il zI$6`BqNA1j1_rvv*U@9%z6Ci=JMR+DgVdj_2ds=QSM@*m-XONg26Ql7s*O+RuMpW2 zFmC#pE$l8gaCwlpb!Iq0Z&kz9v}o_fTUq>fepc zM_c%`*&fAvH2cs4kU?cb#M(J&X0seWzB3sgFlr;*9tQE}Xv*DBC?7U zg!m2!!hNA0*#)QsD!BWb@hPhk7e4rB7=B`g{-oxdj&bg;I!KzA(4s}S9A9l4F$g7eB0 zw=f5jWZePS4Wn7K259~5E2)I9LQi!PN-urp?F3vph-cRY`_qn@`;1S9K8GH!JJ#>z zg|cyirh*!Kpo1-oKE*gB;ga z4a+#BepPKOeLj^yH<;LJYxY;wZ#W7%`Qyl%(~4`Whhtnrd$WD@Lvae^MIhuG_U5B* zZJ5Hri6A$n&MFpUvg0xGF2$r74S3DQQH#JsNN~jd_?_zAHa)4ApSF-0i&@q z{@KYO>*+}x>1p_u!6<|yufi{Nz$>JI!Sk@6O4@p#V~$@KX(YC|>1;94RErh?HZYMLa2IDBo-k9U zVc31Iure{z2P)DPhDJ-KJr}T&1!cC(0;Q?+H>N3E7F$e1` zWQ(*WNabKO*slaG?Y=yH>~eF+<8%0u~C7bC+2S1h-U?$JVpvnW(sM zm_EORz@y-woO}>cE-c6ze2YVhZ=Z8|=zg*0VcHcS3P-1FHZp&f#^;~lSiW2HxT_3` zuTX@#@T1>PBlts`f;C-_7Ll{D7}d!r>6GwB8Ow)z5{wPY z3bd9Hk(_|pv062PDnKj?3JKyH=+sNh%$HtAT3Q%{qc2&@A-}Yu$enBIrLH@Y<=1Or zX_^UPo&S8BiyIAb6*C`;5JBzm^RhwuX5foyBKAf_awShMl^0I$^NXVplp_=3EteSi zGxwW;>TR%dSG^4&c%2iz>~$qBxK9(7R&IpC;LgJf(w24s9q;a=!Vi1n5epUCrKK?m zN)=EY#UQJ|%gf@|xB!cr#~c4{e4{b!C5j*f)4uSNsS-1Q^fcIQZo{_v99AE4*oWk~ zyY+0rb=7g0O7qY;(SbdP8Z7!U=?mxh&UoWB$XMI#QRLZ$ibq1wuK9P^ z`Xe7zEZL5Btv4#C+>K@f#=g}I4+=(}Te-Ad)FQQ#6Zo(19Wmd2EL%TBz(|b@lUUtr z#U1u!2wC1YM@rkR5i=@6P=yNxC4J0Y`@O)2!d}r5k0}+mg`1u>bK=p!L71+8=Wy;j z`n-ZAwK?+%xdO~lk?O=*ln000{MvfoFbH*sQPXQs=vw8SpHjpHLf;7(l*j(U;bNPy zsd`ZagwFV17$JCA>2dLtiLxAMYZ$Aa><_BOvB2u1vfe#SB!tt5Crc&Q&J-)p=_aHUo#j;B^B@8sA_AsvII1Rgv5urjfeeVBh4nS7E*hdY(z6Q8>^5qcmAy5tW9!_DtY*H!=!MT z(SN(oz-4TsW#FnJ2r`@l2U=1}qyy=h+mv^P67I|;V@E%KKNr>WLPq6xS$^6gZ_g-e zZXdtR-y!ey%|LSJPR<|DZ^$I(2|_BJr(FswxmK!ffR>oOrrk8=F{ODPzXSFKqYA;8 z3b<=O#jdBWyB4t;kT)uVzj7`^kqlgY!<2Z%mkMP8e$m%kXnX8rShofSVFm#T_-*$0 zp!7!sAw0p={AZ`+RC~LS)+!WE7a6xN|Bh!hWg@Ray7KtlU#RUVCe3g{G*mxMuzPu- z$AR|_$a?4IE;n{*nT+@ux@E^zeRg4n;Hja;NU4juH*vLyS4O6PbG(%lwN{=GT=aJYOE^CkGipO ze>-i#>~d1gw4K26#bRq!5nwX!;leO_FRZpfkhVK{ii+>_v|siS-kO0E-w>TNvX826 zJ(D2X)bn#enNpy7q$gfRd^C#?I`*gisB9<}#m$GtuyR0k@Q0P-2P~2HE)U6f)*y$F z##D44rf~%+DE%qFbe~$hLxB0N69%KZS}nX%l=21Na3^yp`&{8w1!Kp8LA_CR*UXzHJq~QPt5wAXvtY;Ds;OM3VXsK^Z2q- zO_HI?Qc+gCG;Y3mDEfkYuY|lax|R92fTir;^kfG0c+EmjUaIF|En{JS{3y*y3n>ml zF(SYT1%Tjd1WQWml?#90^0hU~xb{0zNQDkWNFlBL8Ry+<8IFy~5t&vnl7amSUVhpf z8EiS6xRLnco)F;nxQNSNwze=c^dm9LP{5`)VuF&OW&xf+9oNv)Bz5t%>KpE-8x35} zr=KR>zoh*{1#TwlUMZOy>5IEZ49G5esu#b#CFe{Hn0|#zaW;)l3{+9oJG|MI%wbY} z5!m-#tZo+CSF?8gv71Kl!9q^jt`uE|p2yPBabLO@VQzKds_9#F&QHMM_#QTUo2D(G zIZ&YlLuwLtszW`JCdQ$|al*$=pD3C}UWc|M`ARf-&u8P{S&UBOvZUPV#Se-jXKOSb z9L8ZJc}`rfL&<@EL&l5!;q3{W%3!Do*UQ2jElwwYlKjdu`+XhP2`@cJWg$19yD`ok zpu#*R{yj!NEDJv<{qqY^=)~B|3sF1MRt^)sw)6X>y|Hw76ObuM_~4m&XG#F*eJ6xc zT(YuC<;(A|-l}2h!2XsuwDmt*8^3*#s&u)#u6erWviimGdX7ZdX}v{Uhd9@5YUC?I zBsQi;KW-~Q>f8H;^zuea1)O35-+JBX5G@n9 z=Hm8z3CquLd`Pe!tz>0Cue|up=LYv77c|+-!8fjF%kV6cuJ=LHJ^J}1h94)lKbrQS z$E5#MyJ+3Q&Iin=09au`83(!iT)Ka@ru^t%ot`0)>08&Wneb zjB6yLn6~8qGULeq&W!(+(O9}3z`(W1_JS=bVESnw)-LIfG{XS3UBd_TW`cCZX56Pn z2oofNl4aBa$uAK+3zxR*xKcG1hpWP;u48KEp|DgG+{6q6{4yxB6uTi1%^rrcUk9oE zxxF^6q!pi4&`@(~8mORTpN1XzMAi&(Dz;R`FUuotEb%~39sijwKp6IhS8HRsc^MX1 zq8mc+8jAjH_myzC^|{6JaBX>oJgNSwzU+$7`Hjf;{DeXp*8*pY>*P8&^C-Uy=T&YXLniUP)ftK!`(${mNyJa-QpPT& z;|DXEM$0ZP3o<)5C=`oJ?`Qg_@YLx-NgJ`Kmr^$svU6NpRp^SnhTw}IWt`F5H=RZClXK57NpM7uuu!aN(nyYU6ntgn zb908l{*KJz@m_4S*Q55}yHp*kQHywXB_4aT*-Ga-RpXi~CXIF6ttx@KW4W0k&`hzC z@pXnn=in+Ce!QL;yJ7ZA`D^-e&~&1@@YO8J_G}n;WjD8|s*uNdx5k8KKo%;op+EQ& zdwj70omw*bk=w@{UV(!|P0r_hRgsQCXTyW+`$J@d7xG5`ZYcl#=;6+;MbN$Gko9cjiG@s`+goy?zhTw)Q`h(OY5|nr^ zbCF@>n@?X)f_<3y_>(MqD$C=Koid))_7~uVC{?>NxDS`=(aLMhob1oE={Nlt;Qut^ zbQs90H#uo19HcIyZS1@xpusZk+47OxB4@r`iEtWH{4w}SWBo_Yxr7 zp+f4ti?n6!v+z*udA>v^{eCGWi=p%N8b@PHIlIhG2$)p@TuA!oR_#9^k$-H}s(m% z@C*Hvrl%Xa-6%zD*|NV`cJo+XDpe7*6^7y3b!z~IpB?>F={oHbEh%*IYjPaB#WFXg`-`f7=Ntx1 zcI?xL&IjOXV~V7<-gFvU&(`dtVZQ>3$HLz7b$y*NlhEx~sb*~}!__dT4Us3NPVkVN z&m3s3L~>@y*uCflaqj&a)tAg}bP|AIMPr$uP z>#Ot4 z1c(6cw3N6i|IFgVZFM}mQkV;{W$`}hWbkV~7OU|cZzk(ep9fVd#% z;#S|4kJ>o4)x^>)=EuFm#jM-X^CoSz6GBe?U6|{u;-U4v7qw@xsQFhF3;@2+*i_1-JS8IS9CB5G{4;)zw4E~{sSjVuPD+pI58FnHi0R>5c~6rz3fjYN4q#;Z=hKUp= zu)icvZC~_z8Uw1~Bi*Kc674ZR zf?F^k?rPDAT83Zy&dQqGj}5z#MS2QedpJIW4w`w(fC(ogY9=}0n~>G@D?A*`+qu0w z;~|~D6QpmBCgwNO_6_)M&Iw1)6eI#uz+w-0i=GXGYubj0l3FPfkb@y>;P63u{$nmW z#_=^k8eQ+iSPyvd6Qbgc4!D;w-VHywn$OTM_efqBOM691fxOZ!*V_h>9r#cUTde2} zM)xFXyNUw}LTOcJ8?quQXG?6A|3cN5@KEg=YU(vM{kKCYe+6*mQTnd%#)ilO(rFNW zj<6;c-s1F=%b}ra1MiDJQK;k8NMn7^L!iWVTS+R6#w!lGyIBv>&RFYmBxA}Z-IAP2 z00<+MbdW8>tPE}*mz`mb2Tj?qJobINw&?Wt$N`D~riJ+|hCHL>nHwQ2^)v${ixvXo z#OH9u;eJV2VhBa5h*^AeH%Q>4ha7qPh~|5C0bh{QOH08qxY0*WxDfmcVB8Xz`ANjU zwUf0G?q&`z?ImEKE^VMMf`p|^aqWvIa*v6w)j4jX&u-t*Gk5jazS6ZOVWq$?wU;0pZUsUFHUrEJlr$0U$VMh=rWN z*{fx4V|62rGMzNcpymKwOK*o`N!a&&@{OikSOX!rXDa4)Gpl7rkJQ*qQ4hu>j5{6J{siWM_fLn1~lOI%KpsT@|g7gfaD03=Eop%bX;GsSSz>?&sIgHDfza|?%jvGi{6V}(#MjBMf?YGF^l&@B;|f% ziZ8Bfc7Zmd!V38=#m*L4dA=cQsk`L6t?WNu*@A!O$o~1tUgjhu_x^X=_v}VEEJF1! zO0kxA4f8(B-<~XH1bmuKgXtG~7_dX9zsC<`SyNCWDL9cJiCt9-G!Cq@*@>Gt{UB}F zZpl;*{OEtK+I52BI_?TlFE(T23RukIa^IHLM^Ea_w=uppb(^h-KUzR_ZX)ubh(7PS zi(z*$wVHX)W0muI{s!tk!}lf%S)$IrZN*MI#oi8Vp3rnh;?GKps-9`v#Y+C)vj9B8 zv+L{w(<^Vopz!CSJ2RSC{Br@S+UkE`q#deSP_ubA{h<^U2_hO2>`{qWn|Be6P96XC zG}!v<#}W5>cv{FZFuX+Uq-XX5>>3WbG`apTaB+PDYH@k^vrLP`DJZmP+r zqstf5lhV2(h2qHOUym^`a{v^(!T7XzY8BICsrLcc7F%7p>;zq|Pi!u%@XqlDE%hj**qtR1BRAk(L}U6*_f zh?q(Db16qbaGzLce;NK?WdQm$&|7P>0HkrXQCOh`3-s7{MpVrbj5!Iz=x)7eGpyh+ zis{N1ApfKPjo6+HP?grmYtEaq_`mV^)BnKZotTaO;xc$pBIgtlL@~j}d!^%kwoKLI zLq}H>eog>qN?u&b{rpVE@%)@4&4Yg7JF&KdNuYxT6OhvydOsziF$oJ?c3jHft$f#d z_d_vG^c9to68*y);HkC1>C@D&Co2daiSKi8##cqw%x8`x5Q^YyGh9cE>$yKIQyI{$ z@=e&V>T)gY0Y(*7nDm+`5PuJIRyF4P)|@?No8WrDVJ*^P!wGvjAByzCe4zYVHKy($ zU(_-0`1$TUKeAz#EG1tR;xm%Y=mcBW=Ia{hb_$xNl;QVc#;z7hp=39@53=wgIcu$N zrxIR9rw9XG{jRB(`}#$Yl76=Vm?zTHS|8M!5!LbZ_=ova$TO3e24%>gh6eV9Nfam- zC%3f-vUV+qUp@PR5XH-Ju$|E63-fK;qdPrU1|8*mChSv0yNJY^=a86HkR``lehuWe*`OujMjmc`!peTRzPq|19I=OyKV<6EJrp9Uy@ z&ez8^fg{e9&_=xuCw}ww6D+M*F)cd-iT6q!`rEK;-c;&c{<}Lp_QwJ%86K~TN*noe zsF%&h>-M^=2Bosmd@7)e#s4e||Cf%ms*31Y@Ygs*Q`8EywXoPDxPG#PDdMK=IwFJ3 zGWT{mrzocj6LsHxK8fl0T^PnRV54EqnEk_7Jk#(=(INQVAt`?~5!qXjOln~osI06y zaA3SDCnTfVG6Qnf*wo+_c&A996bebc-4hBcA`#TO4>)sv3nY%rluBISj`8vrGEKZ; zud5{!&Hf}n9W4;93>(6O2J)>I{LCXJz*?!D%w?mjNIKBgXy7VPYDK=@T(oUMa>1~! zcbeIh{YH1^FO}odvYpRg5wc<4?t{#5VeUXx`{d!iD}%LY#zh)gh5Ju1SMm6rluSUH}g_A;JK!NhdtcmlENdYy<`<<=kO@u)3uk&7M9Ua8eQx=}=?Scld&IicM_Ds&4{$rAQx zNdP>6toxp!?f3l{WMF<&MOGR=QilazuVc*)AwiYe_h4J2*lE$uj60#CG6rhCpfRIY zw=dDpv3@F-$0T-r)!u6VNv~iO2sJ*V;wOX?J4eO8e%U-r22E@=thiq4Y2|gM2Phmx z6JTRU8{v;taMve8DeQs9U#}FvBe~ zAB5?4YM^1nRsL&UEcG?wLz~r9xDP@e#{o+lz9#z7|DhXhx8bEJPYiXT@vSqCb1CA#lu z+wBfJ*L=5{OI}eR4w|>fRmf$Nhn>da|G#Hxh%$ur%Sez=_64?J9@Kt;cE52xlE zerRXfOlZKrEAWCdU+!+aXot!J()?2Ubi^{lcR6bD`GAImoedO~UWc&MM*Qi938_26 z@03v}COe0b!LmW|I>%8z!Gcr{&&<06WIJNkL1XgBkcP5y?#})sva)35Jpm^ zQr`bThtW>Q&Ry+BvpQ`h_v!QGwmD^kLTZz%Ehm^gt&MU;?mr9D4N_e2pGA7kYvM%j z>IhC|wT-0j&)QbwvOtr=3Tuf zs_HEFcu2mtudIvgAS3z_&;*rsu}FMB|Cz~?({{?Kv=f?&@NO>roBeoeka7I;EK(eW5+3@qj0|w!{Y-BU<$4R>38FYyZWnZqNa>-;6Jmz_t5K4$7@8 zm=v|F+lwM&=h-Z9H9!o^cy+~#Mux8HfJ(-NBolHG2+kn z-T)DW*yevTebJp1q;MvgcQ^?PGIs;F7I64JJu8fE6a#XbfSK}V41emJYTyc-4P4NH z`m}E4W6QD6j&!QDyWt}B?qB?aE)QE(3wNrk?yhL0p-5sG7u(YOgF(yD-PgSsT_B?v zvEN=%uZ|1Mr}hs4AlUDjV*1{&ozNBsr>cL$;V!JTw&H45%kV$(DCpn`LWxBz+XBwL z@6RLRtlH!tqO~(|p(gDNRqZh`L~df122Gm?b>FZ`*&1CPd0>E0Cn3D5Bb%l0X03c; zs=%cm!+2(T9C)*Z0_A`4_6EAl`vRrB7Y|w;tbQq_s=lkSmgtFy6Apm>SbrM-v61o; zOGq}+mn-r1auygzQEY>Qi=Vm)jS86Fq}VmNtlD{QJr*(611Y|ip(u-jPtBp6GZEh^ zJMKlBNWHp0ng0_!9-ATUxNV?iunT$-lJ)6S0os>PZV5|w);n2ZId4T_L2rv+!bj|iC^a&^SEd$ddfE<6 zp`pF)@Zg7yb=^#85T$=B&kC_=6vvkb9eTd+?(Y?7nh|fSX{8=r;^g-}ENc=8Eo}j| zwHICAKZNDsGE}WEKCAXyx2-ZN;V^6 z`lP0!Fd{|HodhRWk?S3FjR(868-Lxw`F^4wl@(6>WAH)mLaF%a#Yb((LZ~+YoBW}u zhk!k>7lyH|vIW9}nqnh`o_9*^^7e72T9osL0XkqHg#*j68Fw+W()U4UYsbbb3Z?1 zoEhmTqrsQifcdB0)p9_5WoFTlTfGO z#6+PIAP}I?F@EUL7{NY)4(C|inpxHQw&z3Zhr^-U(Si{)#AR z^t9Z5PZ*dYX7Gl^A=i)a%QpqUo~9}KybLwUCn)IZ3_T)(W#Lq*hY60r1^LPY%NOH# z64A*99#%O+3J{MY#LSva%o@Pv^xcrT+Xw%xa!uZjExu&PP1-u~2HshEbD+t-0p0Y~ z{4Xl+G^cZ}wJDlD4O9?zCjFrP+I=e0C~!Psbw8}AB~K4!&5ggxKxsVg7%RZz+-@T5 z9cVg@msGLaMT{8tb_sMK1Zq^EG?U*UA-flR2>^O|Jlxdz}etT zmum5{IjZt!E5qfxWixjyOFk1-)ZSQf1K2j=uJd-6h5kbm1=h~Q0EKrC&vkcOCKMu# z@;-EzX^kXGGyY^wgi^VvLH}uNUKd&ZcY<91By|u4Y8yvi!?#B=*u|ZilXrJi9{nE1 zDv-h|)kH9-aU(Qm!N~LDd1vBbe}ydg=2waH5&vSof*CW^RM}Y9@7y0hA)4+kgY&P{ z>r@Mf_~N*~`BPq)^GZQ2dGPsNI1{?+&3uGSF+DqgaHB{_s61jb&H-U9Xk_?ro}Y)dFlSMfmYcVr z?l0=$8X@t^-pdpu-pQwoo~gm9pD?cb65}jDRU$Ur=%&Q6psuDmL<8uKNPNfrjaa{5 zSrN%HIzk2WXPr=koy2(@OV?Jd$7zJLf&x;HP*_hTKaK@W3z=DztgEjr0DrOh@%VY` z=9J$vxW~43#{7P~0&7o>sF z{w<%j)#)NpM0t`9oVk6F)RThR98VpBkM}AJLeBmWe+}NjeU-Gr=TdrwLYS`kLOK#Ci&NIfxF_kZ-ReHA#|SJ`|qA)2Ln(^z>oOAu;BpFLAyCK~~uky;sy z&4Fu`xLy=kwSOs4}KJ^v;$+m;0+z{{&kko-CDtC?dh?hy7*Or4Ty| zs8fDqWCUyB+{#aC8J-nUnfHWQthKw+ZK+NBMeC(bF4R-Nxl(>+*(8^&1XqVAirfi=AkIAJ6STZFw>8*~fYJTUYGL|Dz#wiDYnLg$gP1_j@uV^(vn4Dl>_6I zVUqYuGMsYyhqAlO#xju(-(O4wk=p+WdD3)^YfRS*J!~EYVn_LASQ+~qNY-x4n^{+4 ziJja0AwYq&GnheTEJUj7uY;oot)%I;Bbf9PSsH}khlev8vdxP*NO)UwDx2lFxThzE zFNc%>hO(!A4xd|B{Qe+WdtN7WO}i!zi}OwE`oywIKk|^ZrRnaq1N}?a&Anl9n?L1H z11Uu(A_7&=Jw`qiatF{Ox6tp9d`zTGp%SvbQoHCch@_Tl5To&|su!y9;z>%;TYkl%uFAykgA+jz|y zx3@O1$b9G8`_H#0G4~t38mBZ~mAq%e!^4xU7oV2k3p;oTQEf_H&*=XVhnW9A;}HMN zF;1|+a+okS%fa@3J=5DR>>R7#B`O+xTX($K#*9i4-I*SEWHVutDQ<+qfMDVmT2z#j zBF1*MHM}swk&lNGMY892l+2edjlm{R*(e0C_s^j=kqDXCKHKc;#N&Dy4=_D)BdW$o zw@fh1tOtIbKIJH{%USf2_aAyS5%RdMx~u@w+EGU6d`LU;#W8HpKQO{%2a0OAhZC`NNg z=YCCpnENbe2hk!S6DV>CTE+eG^;5D$<(>OSAEPx8Bf}Rt9yZbz4=PTPa|4k}Pa*zweUAA3bI!4>!e|FQjOnXYp=| zd~qhoVn=f>4Vw%3a`g1Ax3->r=LxVo-edt9*ZOPQUS)4NtJdr4*$>_?X@h)S$(oCt zx4qnvZo7JWB|k}GutVkh0RGO`HJIc(L#-QZw6QkF6*{EI1;IP#xdsXQGzrX?VvmN1 zl!50`#)^kpzyw{Z%t{E`ouuAVWwC1FJ@F1ePzZ}_)rPV9bH}deNX}U`I6c>2C`a+< zo=UyO!G9u#KWQ1ymDWF`>sLpc2)eI%zf^~z8OI+-Yr+Cg)0_4kvVu|@)?RY{^62B= zo1NWnO;cH+d*p$$(iT!9J;{XLP;_j^Xm?>^L$~wQ9Qe!B)S{@-o&fZqfZk9vNl2jJ zWmIoJ`r(H5ie~Uc_G3TaJM|i3$A1XwnF1$ifP*sDZ-kVAYdG~$7j+FeD#RGVcOl(PaCLU z57^u^@lmiHzgX_GcOZ^z12hg#kk#GJURit!$Q^*r)#R@}eDB1;q$k8*M-pfUis_=L z1b8@vZD(?4>R!QI1M|AJTDI`sRIOuB`a>jf3;PfcWWr>}rXHY~CBo^+t%UAQNW+<2 zZYN);(E<)A$*M@&3Kk#X_QLQC>3Rb(HYd8f8aQ=0O%XkS$Gq&^bg_mdH$^>(VIbJR z`M4A=>@FMp?m{-VAgcn6zs{|e7Uq(PKRQz$mdb^z>*kK^5B+NIJ94iPVsp}!@at{L zMSyzy32jfaQ@>R!zYt*rQHPA*3&+!r4571KJKU_5hWHzrX1A2(=G@1_h0RlZNi*v9 zuL+9+Hy3Uz^nZ9otdK6~yE+Q|zrp2n-ZX4Ey4O|7RHb%+`hDUq(^>WZ5J><};EY-1 z1~J{poKxB^)?2@#Dh-Q1ygrjO>(nq+wRMiv0M1Fnpp&kKzHPw6hd|G6CA($qt|8e7 zBDD5-`1!1IUb|d3Bgi!IxW(k@TxUOh?PqdhoTO+M%# zl@>*VY;S1zl_<*=nh&24h5+j7ntCFJ2C_RG5c}x!Am-Se!+#^MCj$Q(c?AzoMEdFK z$U=tLQyJxu`#^4+;}J1&-8IO(>$?oB3i&-eX-rN$asY)jzsvA%c_16;t+EV$)(y)tQg zXt|9eiBs`VO2A>mxnRnuQOl_7Iww|Ci-_7z#NI<+jd>hlu9Ga0+H5C+xU&S=hWE_6 zzbF+VC>hwlze#Yh&n3!osVuE*+GwBC^1N`%TSUuU+T6L14Xk{=2CqFEg8HgDA(D9g zn$=o+u~P9Y2d(rHs-TXbotc(sA1Rq`AB?$$5xx{f{)Bxu8Zjdwr()XUSbbg z+4GT{{~W}xQqI3D3jEaS&v0>KX{0x{biP%bk{^ZQAbLYYs7KT2ZZgheoZV`01K_iK zT$S%EWM7z&be2w|>+22h8?>4j$)Og9{g==0G`N95y8PN&B}o~Il2FX;Th>#^fzc=c zAU0m{x{{YDEA?};O`Ry_J|DX$Nm@te6S;*&!GKEh1Y<-+W7Wq2*+KHdhk}+C>;>-& zqpun}zpyE(riz)3=BZ@}a)@*_6?T+TS1vb*)LTwZe9pJpEAJg%*ZilEoD?0^Z4wr~ zB-IIU3zy5x93L~5l+$<4SL#DVapa2^#ASIkZ0{#>a z6pnRqyG0$c1;mQ$ltYg;H3IJeb~qNEd|pjkGx=vCsX9xeo2L5h^8ipI+;I`K*zS2GVX_lNoU@tjAW{55Uthn|YYjhb31!*XP8IN!51UblqAfC2kWCn;F8wQDU?7g)D`$H(U>%jqBfIBh}p z6WTFOCUlq!H>Rk1^Wtx#3h;UwC-^%3S3WVMwYP&gIRzPG&~DWY4J}2$nP(xSMT_u3 z-58^tGNVg2m2IrBxU^L$D+mYV$Ut1$irVBJ^U&}oD?Vi4{E}0>ipe!&l-?Fj2&kVB z9vS%9te!SHF?g;Q^F9B#tQu^BPkSbMcS?p7|K`8=bWP)=rKO2e9zv2n`du^Vwp!kn z6RCfnnVIl2l$Dj;%OmsEdEFs{OqKgKZO_xitJ3D*)K`7AQD3V_BqI_98|~Hm($Rz( zM}HK%&3z4-9@>20`~dc60}TbMCb>2V(_3UA!C&KQpSUU*J=W-we2xeYi+}S&o_e<% z&@jCCkaX(z9A9p4FHO0-towYRH?=+$biI5~;N_LYdO;GQJdyy!CpSSK-bZ69z$!^_ zVKKv;j?Hc&4}{H8rV6G>y^KR+2An2(%#-_}~sn5kFa+Bo5_>wMYt@c&bql!^!1iCZlQ z0YPpn@be2x^-0@2gn~gC5R{<-(Mv9*_^xf7T=wRN=+r;RxU>w)U+Bm~K&V*IyYa)s zUL%eBM&}ss@6CYux0|72GJT#m@tW{o-HA6y%rr1s&0AbK&sxpS1yV)!uUDOr1?P?S zR#zG(HzUS`o6Z-1e^!UKX1R@h|0fK8>NwG-OZ9cmD&H(PP08K<3$WggV}U9e`Hu=Q z+L z&2`R~nhAS$^V8Yen5D39m1&YHP}W%APM*tGx@Ab@Mu-E)Ds% z{`<=?IsSNk@mK4?kByOv>B^forSH+EYrKCnk=PsoZkRaz&RKlZIxV3`?;^Ohm=hfR z_{y;Kr#Q*pOHsHRd2Jk=tT;5eMK*j0(k4%cJ@{OPQBMX=#nx|lFKn;;)d%``aSHM> z7`^<-OJ9jI^g&@rA2C0%W5K0W>02TX#Gr*H**6P56oLE{lz#F2_8YlWJ_pdef|17z`XW>+{g;^jg z7vR9)-mTS&)dsIT(}LilvXw5m%gK@U$1CSyhF)~upuzaLC>8md31&; zn#`1y;t|20&ywhOr>r3~zFZb7Ia3xb2Jrp0_N<~Du(|rR(i*mG8L|p}4|PPDdNQ#pnX)I9UZ+rpTD$r~~yv--LklEa~wM zWa*XF)9S{Vk%5Gi(9*@#yIRO@vtK>Sf((q}f|j)#mjd=5IdN-^AK(?{w9PVl^4H{Y zz*I2U$SP-;=HqxXj`q4bT*vE2HW1ju zVTvK<0po&m&i6B`51)qW+SZ-?(b-4E$A*tli8vmeZkP=5D$e&L8Pds}>)-*=2#+?V zv8lX7#eu#k?%`5^zX9?IZx@>D_|iwM$Y*CjT&Ac8Qc0{zqO7-#o?O-GVvEG^h^11v zOSZY?-q2xF3hA1C>T0!HyQ>?AcG7UJY1YJ5DGtW9eIOoz3GYu>FVRaWZ2e=%vVcdKAASDV{}5L= zyXd@Z(Zt0cGB{zR;oxC@9ZudxPa4yW6!OrL{~_WVRAU8kvMH{Z{k45L)U?{{o0o(e z=G;1VAVqLgSTt@pecu2dk+{|# z43Ho@ca(}&rn~Z2SgZ8?b5Ab5UJyHNcVc9dw6CffBX53L)AT}dmC6$_qZht*u)g8# z({WeOpqj)cMiVFETJ#4kS{z-3Zo=n9f`R^0Eo~Gbc13>ktzLL(%}NTMTc*JB)!oW45V7`iN3ds0_5`dR+)k`qyuD{o4l1>P45 zQ~NH$I3eoPiHaUO%;Z2EUtgA*mw&5BEkjG8=)Lb2)k|eoL$;lx7|JZZbgBc*OO8~a z;Mwn7HDwAcyz_F@`CL)FK+`-(*Hc4yozGe=Qq{_Fk%Ss2zoBOY1S!>OXo~dDsmBC^ zdY)AFgZ8ZpfKL30nBn!&UOP4UEz*!KOm$I=qu_}KCJ|14;n+IRvzzXfB;;jr!l_JO z2A0|}3Nx48D+;yGbnRV;0(1dwmNDU!3hv2wvrJpTr5zJaX^}B;c9IR~G54#47K@we z=g)cMB~M?!X{6OXAJ+Q+OLzQ#R_=fN9wo8aQ=sbQJAtL!UZZy2>5`}aP~^|D)$uti z{E($2c`pa70oG0aE$Y^w#cFt-BzL|N>pDdt;C5cKTI&)8?eAC)=LZJp_9mxhIAPUl z>2>J4#ec544erBdNnJ$O4WpzA?yBqIpa0a9m8Hx7J;|oWTk*crAvSU8rWsb9_xavW zV?Y%Gy+bxLSRKQA>TVNN3KA+&HsI&EwAlV#Ikq;6jQOgh*hiCv*Z$rJ*5@j307 zqn9u3_yE0ZXQEI4U+o^W`RFpmOhf%R!c^5+ra_zIV_fU%dw*{=O=*Dr#ieRi_;Tf` zrqriCk$S`LKJA+%=%o4ziBOW^Y>;fpg3(4K2N0dxc5gG3V#QW>^0&;z)Y$ZvJ`xMs z<}hWoJHMI=WlDtgC1^I6SAU+b(Djp|`7QUclafl#kMimYX69DX)?EQwf+HI9$Ln6f zw)uOHsp}~?Kdl7CRr-pw;MNgZ@&H`nL|Wgt6i+>Fu`tqthy){D0PILEB;G zcY)&`9ZWbHCN}M>|BJo1j%s_|)`iz9v}g+rE-jYePHAz9hv31zNT7Ie4HR0S6br$< zK!SU5Z7HtBp;&Q;;tpTB&N<)N_l~>IU1NOv`)`lIA0aT{moeWt=kq*MUWV1%I8wqV zlZnoC%~1G)6L|Q?m20AQb`FxGh#gYRsc&e^ZRli}I3uw@)ME+#A?gF$4_t7Kj?4A&eJ{wSVY%!$*xiWn<;#}xd zi4eeQNAAhK_43?17F3b-OGeC$z~y(<0#2Uc#5~L?h`LuMcQ0J#_bGVO3>$>}bqe_Z z#iu~%bUicXnQHNEYUAaZZM)J|pHTDt%BAoCHtqoR+Hq6%uLtJ^1P$0VeY?oey*X}B zN7n3VupcEQZOn@WVMd0y6`j?(@u6+~HiVE`dNWFsS-13c+zf;1Woa#~=jnql+507B zz30i3?mu!3O0Y*#LIV_}2RsXPJciD0)>lutr#*iGAyHQ=B+&~js(G3VSiwDKa8@rV zK;7o=3Y)`a62~ts=@MfCniGxoP3=i>&vsH9f;u> z70Ut`p3%Ek36!)z=$LwKs!Z3w(mCz&d*Yww@zw*seGNx`Q31U)JIq~bI#HGX%dR^A zO1u6SyO>J+BUte&s$`Gquh`0_`mc1liP1v+B|H{vNrBp?kr-C%K?nbvA7w}B zZ5s;SrE?bX7da-)`&W_Ue^4&Uc`(}4=@Y{_fxnERnf5o0f)Pp1hOO`ZmPNj_V35)e zPkZ;F|1gO2zYX#a7Wl6d^`BbCzYX$l4^jQMhx~6|@sHpB+e7~CA^*%nT=8QIfbHcd z%&i8GS#J9)gyy*IDHJr1$KTAYwI<&JAhV9?Bs8t4-(jib99Dp~|b)Nj03o z^)KS+r31UY!qUw{?~@D73hcf0Epd~hPj>bg4e%i^9ddj^__wfkjZnVl5&Jiw$XjfC zFeZgR#2KIZ3-d%CNx^gfk4gL$8MEfW2W7XN*o|Lucw_dRS1v_DMj84PdAv6A*)sBDgQO!a{Lg1sgXfuxN3? zxYQtK;~_;H2Vrd}JRFQ1`)H;r0#j~}tH7|f=imCH{*Q+L-{1Ta8if&PQi+6r%QMq# z5>M2+Ukfn~aB)}`;y@9su@0Jwk2ypL>I_Y=s-Y(vF#js)cLddGIs z$0HVxB;P&rCmaefyhcBSs@JP_&YXhXP%3?~xg3ke#+8SU*^H0)j%>w_Ag8LGWfFbd zWq>+O1InSj;ugBGsA+4HXr?G_haA6zxw~e6k+HK#lCG`+#)bnSca;-I&2_a7z|mzC z?^CDioem|`V8+TMukzDajbLNHz|<0OZ2$kkwWWgx^tD17@kR&!i!z+4E`zzlJoYAAWVyId1o4|g)^){ z70sI)|2BVSQ+dnblLx{3-kka)(iaOnXuHhsK`;*x3G-(lzvPj)6Q&GQECJ@ilzsMQ z{)#Zvit`+Q?=!xQ!T1-`LmK~F42y)~J@VzLQ9A3cvo~sms;1k-j|;|E)>n8;MC9>$ z!`m#yX1TBwGGjN?i>#>gn^oAK!^wkCki(`1^`!ToaM@Ji?M=J0q03P4pYDubc~aAo z#phR#Hb}*F8IV$W+0*0RO4!z(zbmX+v5!gEfUAWoGuuiMTGlQ?X+JZBLjhvr7uW&F z5bR0LtJDk4=4BHRe-p-vq}j<4PO_{of@%u^=lkvrE7czAhnC;q0jxI)t)S5y-DAhE zmnG1NLsZ>0sQz0iNSXPolbbo@oqTyUhF-f_jjeq!pJ7Wliz3us_tfQe!IjR5Q zMd;x>Omg}o0>g>vdfC3J#{REK;C~NB|MAneT)$I82d_yZ36)u;t{=k8@9RCy&BYxJ z18V7SdOxPo5Ghj`7Y%4S2}mTbi}`b2-I^L#c>dw&!8M+v$a;QF)Az%%-lbgV>?_HZPcXs*#XBVd#3z+CyMQ7zPu{os4KdXiBc zZ&-E{|8%t)LF|J#XvM{65u1@ZZqZx1l=q6=F=5@fz*JNnTnLB((5h<* zHsh1Wo1({pcxRczEUftkEUR20|R3qURYzxWPTMhyYee%KM7kQ59h8}s77FW{**nY`&OBm1TR^O%~3U!lniH=Ntt;Gj3(Hw zEP7OX_oKYjwXcL**<|NQoF>9+g2~urE@idS^A2xwb2E{vZwrm*664&19}95_S9`bt zsG85F{@}=l)SqemG@3kGE9esmG#3lcu19aSDpuQETiZEZXs{u3^HXvN z_b&dQifF<$;LOUntQd%iZCY3H$t1x4^SX9dqaUkM6cOG#+NSTw*`AFL5orOBSL=vi zY9#?a47%g~fXCa{ayilH=FJS>~Q>u!J zM_ACxEve&&K|k)@w_;XiZym}ac|Pu%kEB^YYU;OW*f36DH*>*2>U0%zJuB zg5K9YBvks-(qGqL<X0%s-Q>YG`lCS-)0vxeNa^t-gND=PC2me)3cb!e`uL@KL3~$X%JVPCS$XQy z3;VwUG78?AEdDohBF$ep@jwIhvc>i1d*w)#o~;nu0-^`)c8X;E__1&%3m0<6bQ+Li zZK(-!i(UBzJxEz3jV&EOPGvuyoxmQy^Kjfa$2xhuz>89P9vfK=VPKZZ_l;iFA!pVs zsG_yqj^mKYIsA1aimJ?(6=}F!-ECHY>B|+^8=91LblOvlPsuCbz$g#$1NwZ^mMSZ$Mt|Cbu;Zny7@XPG> zUytU>C+IV8_HVh>Q`~Mf320TJ%-ryLl@Qlc}vYd0;fPC>fb$WRgVpS-msfhR+rEO zG+0uH=|-YEDqC89#BHG8_pm~&=<24pv0^m=-_{dCsHY=t)(j+g+kmLV?k{Xq5_ib< zPTwk0P4#*mmSAt`YFGD%BZip~wfj;(rV!_SI*@XIoc7r7X;)UdEv9WNT0_ENk4(ol z-?da)p|ZFXG7&~0?>p?cNWhfhxMnWYOA!EO0)p%8-m1H63g3=U(uya<5g#=QMH}-g zc117KB8+F#je~D-fY@f0ucw>OBdV&z`qJ=X!7<^lR6z(;a@orq2!}v|qVD``6M&g7 zqaw^PVu*%c{0CDDQXWVy@rQGz!G)@i_d>AZtY+Q*`(wI`5Y>tI1*ml@>PvsIuaJV) ztFxG@WV199W(z(%qO=%Z)L21FYy6f%y{^M}`+y3}dpKD08(FP3yxH2uO zF74|rH!aN_KT}Jz;JjZ`qXcuWFE$xwb=ni=EGp!%bRFICy#8_!5Z4ohb*UHshhfXX zC^*STAe1+`(-jU)T-6aR8W|%)WMa9`xJ(M-$9~ksK^-qY5g+-k_YSx~R(Vw-vy@TC zm}*P`;-6)A3}Bnj@>I${c;xp8GeellrOcfB0Jd>Vwz^Z$^t3 z)A&C$s{SK>n05JGt9OxcadiUsI1g{WCwvsW**CAjD&ng(Qlqn~9V_lW85hUm~o> zGE*zs5nFc@92ta8Kec@5d=uB~IBEIb_TnJPbidX5to z>0Wrwdyx2CNxv@#@gVgmBZp+U6w*E+vsCY}YNv<$HHs+U8!OP`j%3y(T>VSOTol z-o`>XZ~LRizeNec%-bww>2{?&qyg>2F~>HzIG$pz+nQ0hAyV|-FdviurJHm%a-fsD zH4r%~IXdZi5zec9P3#ytED83aEGnF7!5!Z6Xf}>)HIQ^(eXCj?u5z5bmiwb8uwJL? z`YD_K#Ru~0<3NJ*ZH#C5p5DaEhH|Iui7l}uas)o%-*rOF#5fjWJG!^-R~tq13Wsxjka zdB(skaxudwISS_Z?q-T0{~x=^o`UkYpT28Sal;-<&2`^bjfUQ)$wODyRP0cA3wDy; zn_LBt?!#E1Pv;<0&p6Y|?(iT=L>q#)m1NNB6D4p#N23ggZ>jmU(O6^6_O9eWaS*OS z#ex2ZWzTKkRL|he&u3gxeu;Hh?tqXq&&tobJ}kK_gAO#PmQu)R^G(h9pua*;Sk|nK zwyni<0}K6<6CY@K%_FHR6yqveF0-tXPj&YhmxCxi(~Wq{l?H_DS092ndeYOLDqOD4 zoG%blDYkfZG=l@Uvw3Z3i{!5DNrB_A-*7q{HzSYvAH(%Of32r=kCfSoc)uMuQgTWc zU%F=kW??HRDoNO#ag4331jMEagspVGQ&0tOqdnN()_t~He{N%2+=s{L95*TEyp?u* zeA+j`MT4%%-FmRk=~@S1j%C#^#%``SP!#stDJCS0=!T%2=O*IVR3ew^TqxPzJKVfG z{L(ywt_=VWraQ%|JglyKa1ZUSpU;~t8@By*c}UT6BZyoRzvu-c)vw23B3+V>xGpz= zU_}s?iqUk=C@6l+$|x=49-HAE9-iQ=jZw+y?E^J9opis@p5`0^i(f@>u7XWY@qIiqswXAF#x82qydLy<0|rldLr`{7MW2$7xM@ zENOkJ4K*%*I%#;r_oj(mj9Lxd9-^5JclmR^39VlbAug&Kok7^@ zn+A;yQt7+3w4orJv|<VR>*!Kpl!T^A+9l9R%9mHvT_?SKSv}FX;0bkqL}Ow zlU~PXp8%iKEPM|t1u)0U3V9tWAjU;_hpbQ<-~`p#0Dh6&p&TR|$8-3Dbpu#)I=c{j& zTuzop66}%p-nNoJQ$4NrsLIT4ir@E~PZ3+LH6!9gpN-Ow+>U+TIrMg$Hq&M3bYK^F zp_ROL)cg+2OFQP8RnVmMT!#A8{1J8HHW~93U#6NALKBb!kvB3)e(VvsK6s`N*Ui^j zxCh?eqV1F$Fn0HkZ_?8yeSe(j{oJXLH_TImGW#qavLIJj3P3c=C5;-k(m%z0TNk`- za0pV)HP;kjcoBT&tXpX`_(&c$UMNrX)m2bPi1Ca*zJifd@0UA~(H6pk_HIMQ6Y^NL zClQgc{h(1aB^A|;$S4Bfi!NLb5i=dwFT=_6r-9nFclapFCamvf81v#1DW1)@c8hh@ zah#;1kse*#E$p$)U0*mEZjmrz`pkq|*_Q#KIx_vuPnN9c)mhg~F72FO=04}5+@@dI zJbcJrT_HQ9GJ5L$3=_??;E<*CRW{ilj8K7beveH-F2ACEZTjT`oo%Ba8PuV#Hs6=JP1N+L(>ky5y^6yjjkj|yZ{U=D&o81)N-k!Ki#A( zais{nkgBVrQqoBpGbdK1jFMd)pFFd}v)!)rDd6HlK8~xz+Od%SJG9a)-%rp$X@d&7f$dN9h+a zvN#MjTdp$Mnv=TB#Ey_KZf(R=F4S>TL2=TOpZR{eWc*k;J)g{RAlp0+mX}gtZP?qp)unhS)J}tYQA(01nc#VX(bt2oy9U88gEItsx zVdheG;y@*IswUJk9;aNL2-txfpLnbaSw-tqj?=HLZ8+gO+K66ys|+D`jakYa2QUR^YVxveR6mPZ<=yv%9#V*&A%&+@1v#L(Bho;^ zkkAZTAvQeBWG2?Ql?)B@!U$+N=x;4pcO;wE&6hP=J#$NIIF`TKJsEJBj2|DVfK)>g zc9E95%_HJtJi#|k;nph=gcQRQMr9-23&7%*d7= z&)mDm-hZ&wpue8^PqLX+?#~5$Ij0+KOHE1b;Mk)uoqMt*>utfaqU8BUPliC-3UQ~M zq-?`0XZ6<9E_oIW{}w4~#Os2LyB!ztwiVKqAGL#~Be1pctJ!z44qqFqTrw&brd}2i z8VR#*zG)TeebHNZLS*Hna7RnIff$^Czj^_RSMdZJ-xxSA`mW~U#U{l%gOOM)Em$^Z zkhS#uQbO*)l!wszRo!33MJ8N+^$EPf;v)q0*LeaXevnQvL6;uiMzLSr-}uG&bLDQU ztF=WAJQ#E%8OU6S=6SY6ccxkBzVD~qgsS$uTp;d5soE-ibjj0H{0I-dGm$ifROuXA zTwGf7!&26XnPZ7R`V#ry5AuzcPm ze{o;VF&;T+%LKas_?uxG+2-R3Lku?FSgOwM+y)+ff+UMlHyH=mg>s;&H4^4=Ur0|4 z8L@*M{ecKyZh@Y3Ua{5vJJObLE#bq;1ht|2&~LQ<$FBgNJ(k14mTx1KR%pM=Sh~r|P6ElB zU|I^?TEimR)!k6SV>P!EtKhM|HH4-ts1MH#L5nx)MxwIwjwG;sQ=} zO=EF^H9UT&HZ~^1Zdjf$i7|HN!V(A8;imPuWhj=SBhJXJ2t##2RaLcJLf>U|U-j|D z$X+ubIbtKOlpU-v4T`EvQq82vUf}-#6adJ0ET>75xU7y#W*9Hkf0DJ`JLf`?F~S~) zkH}-f_m1@Drdf9YJKHc0(~zVGB%30mt98#B_^r}GtmG=%e<(zFop@|uuA*6Sl0UV$InK>^4)eXoD6uM?d3@n0diMqB=HzP zvGd7urPzJ`A8ehwdGu{Gd)Rih)%w)?Ikwf?+_`S`DDp(PFo?B4IocieTngp-a;d*3 zuZ1y;%NK$Sd|>bS>Df+|^2?2sx0E!YRr&2bT&a`YKjQn^1!MonRYkq;)B#sw*8h-$ z*h>`HW(rPUSROBNAZ(Znu%WBn1Vt~pzZ~qpl>G*`&7iFFmcJ;XHjX@!*)vyi$^KcDp-H@1_+@2gF@) zo6AdXa4c<`$__8VM*VpVryYV)A&vUh5C?I}MVbl>ZkHd65a0FFUYJ4SXT$^7a|p~Q zYq+*$4*Z(S1t_a9!PRxx?cpmCsoVrB5%aH zUPO+OS+@3X;b3(zK(63bhYvMuemr}sNLI}PP&ChbG)cOr#1)(n*Jg(o8zTj7*}vsl zqlaKGQ++3x5=C56+BT7ltmPPV_u7BCqyZ=GOy6n8`ADGaQGC`GgZBro*8-P7rFg05AMuyrweS zTF6bp&~|gKya;-qw1uN{W_YkEudwzS`M%KLjS_hCC>!N_FZm1D(fGB&Lchb$xyRoc zH|T(~0c%@g-Hz>o)O$DYW_^VleOe^f0T}fz|Mx=gVIq<44VL^G?{SO=rvLOGM<|GH1K$qxbf!xrKv(tM2aOUbV(5S5NG2?juP} z+h}_~v~8t7mF+Euz{eNx5|FbHdpePuZ$>`F6g}aJ5oUlR;Mw(0A3jfY5iC#etByz0 z4fXe1chu=`d~Z!URc{!XtfdQ&>6--tf#&Y2H*N1M^@A;YUlJb~&mGf-Q?t0Y#v0=s zNJN^=H-O%fE>|W*hZF1SI)izkfmwTx>YFA>R`X*P7X1 z%YdIefvQhuqlcYQujH-#D?WX)eKMcZ3M?tRSy)oFY*}CtiwBgzWhaVTR3HcQgZQqE zYNm0+1s_PItmbR7rFyO3U#G_N7GU27S}e4Cny!h8&ggdVXtf&ml|BOYTT$T0>H}V! zS$i~nw*EcmW>xTu5U2zEojShtW~&yJ)uQ9Sc{J2LyqveHFx1MaCUILn>p%10qGQ{4 zWxcG0En31a)9*Ous`MyoO~Rhrj6d*M{|)hKL!%Fj44T6Tj@!w=?ZfhPigo!QXU%yl#712m&gLK=lWA;X=RP@vO1|;4G~d}PExK`oG=ff*99tJFJcyzrgHbFVBsh5 zpGOhzb0KU+S`fWgmqrtn13s($rdTajn;0n@papewDn{6zk&d*7FdUEu**t+vWyt)P zRHN@=W6!ORf8nag5ch)g=3qE2C+4w;iR#cEh-IEL9 zea4fMvs`(H`(7UP*`a_Zajf2H*=K`-JgW1 zK3zf{pZ(lpQ=6*!xFJJ{J-Eu}O7feLJ=9Pz;6%BDLBUuyD1%+NMB>Hb6VysMF(j;r zv`xPaWw5Ra9-1#Rj$avb{kXks_Jz*feHb0oXQ0kLm8ocksZl`s`xN<;j-rmA^$MMB z#2JWBUNeYW86+HC0{I0QZ?0}bfe3TV4h*^;H+RDh_=Pr{D;}4s;Yi7)(m}6KBr_C@ z_vgd#Z>tmVhk|?UQ?>p5JSPz>=_b6J%kXxUx4Md!GT;Stm*0l zA;Z_JMaT8+~4+Fq^Q7ERWmz8nha{ zEpoN%SHqKhxxle-GU-*CTx00Z+UvcAQS&n772q*&Nj{XJH4C#6yw-6?DuB}gK*3=vKC#@f+@m%ypfZ`OznOOto+g$I5YuqmdZ7%{-NI- zaFW(TTd>fx<)?w$0+H6*zt1wbikGk)^U$V16R+T%wSNTvgwr4`>^u-olX)(Q{^Z!) zbbdHP{CL@AatkKXtgRSk=C}U-O3i8>E~MPE!Cs;r)}GM@X~In#5q`$3z`*lj$)t8J z7X`%~)jQj=+h=@SVWd<%eLyL6se-zGItg6RH)^Vjkww;u_){J9zK;7jBPZ)j2bny?%?$@I!>YJT#BQU}?9D$BIo7PBG{c(rnEDqF9>&K{zgFIcTX0@d!*>!s=NPz zH!F=n{V zw1Jy_mn?|-3Ix_+LoG6gsiv1rw>URY??capxkV#HJqfz`!IcYq z#gSic458VV3JCfom4wQfEFa%SsEa5%>I^(O6(*Wd`dmwE2^sdxV_K; zAvW|n9G0w)JUI2D$ZATDT19M%}E2jIAmJK$)c7P zM+SL7EBU958fXEJHj@lmzd3olF6#!CcW!3wjTg1r6MZY&g@Q_nEgWOe= z*=4CXxJwN_EcG`4_*6+X@=15()c{qdki*?#YyahY<%iJvGaumGP%E9z$}Y_Xhv zd=Zl#u3IKB$wGkwhO)3~ba&u=uzDJ&;DIhu zX$Q8KQGf(p{#+lJ4Na+SSsG`J@xxyaj1c|I`ncYHHA}W1C2N zEuy;}9NLbf7G}2-B($7#m9jX_l8-tQUs!>4kG3Qx#APoYxT&^^QY%r*;?K!5;`H{V zoU3G1YdH()xJ~iq6O+%X8;dpA_pX~r<0g83eqFab9BK68fepT()nmF{Qv(|}5v-QA z@(d=sO*;c$$lE?m;Ob+*Vc{)1s7ACkcYa}>2$0R*Et85G@V`rH6&UkOZ1syr6?*n= z@|8t&L802(?4q>}arc_8;yJy4c2iMx@YofDYas{SS+k8#c)zFipM_KyZuyGVToSn0 z_A{Yd>WX*Z+$=@%Mhr0_IH=OK=Qn#kM}T(cH<#U5p4~mmUBFp)1M1ksj>xk()p5ZL z$}?&n15ioE0Kn4=<}D@5-e!$B_2XmNOz{XMF6&LethxBgd(=vXd=%});S}5cC9B^v z!{|9y|qn)F}?@rxx?PQ+7*Ez35G@wM}c(AUNw@#X1W$u zPx~3hA^#;ljj$+%sB|QSe+|u{j#1v7;PWvCjYE@*)3c038(hn~>lXp~wuLb%?j(tn z5QkcLKy96!7<3F8E9&ZJ{<3p$C*ifJ9i|ocr6F%X-swq zEX5dWl?y$1r76`EL}>noJ8mzY5Ck!r@yISS?Yv<#ym~ff%UzuX%k2 zDAqWDZa-f2gW$iD$la-W7<6D%o)?c%)%{3*jQfI&T}#DrERWV;#aG2B0Z^ ztWc?npCS)R7Au>OW_|lcKt0;k3aIUg2O!n((4&iWQxenua5(kYS(slsvX-{Mk_mw% z9Tih@$)>cZfpkKYfCia}hLs9syaOt{-q54Cxm!Hkm&AhW75T^Y2Z4@MBDECK+J>sQ z$}+^^?j=Y|Y<_y|3?Q@}y84*yOoovB!cg+y&)h)%PLAi@9i*LrMVtAa4|UFE+^7hj^kwLx z7#n8m#m+}*Ef+HruaS#PB9Q6Bb9$>tW|SYT1sQwX#>-X|mWFe1XZtSxdMDT7FR7*X zV$a?Jrm`3g;?7=5_u-}#me~j@@YNJp;-bC!&^#Nu?D1N1Ly8*NlAam$bwGw7W_meq z=;NCRQF^;c$=fmnBTn)$SKQ{Fknp5g(mk&{p>fg0EhV{Tfw&dDx9wB*!uwhPbRQqj z+=iykE3SNF4$W^~dCJkrLy_M38BSbt11P^J??TWLd;CYrl~O8aE?v4e2n7rHG1Sx*W5V& ziXp?-_P24JB4r1T!JiVp2t{jUM^`gyzXO-;hOlRN<8)xTFMS{!Fpo>cS%XRXQ$2C){Um$mDe*9xyQBgfRRCb?6n%yEl`;nS}w5%6ZyE9joUTOe3+i zBFspKYzd|3^z>s08FnY{_i&SLBiCYdoy*qt-%e>Ix0{2`@4xH2^j1HbHT`TLxiEaI zRFAmg{3$FI!Sx`iu($@4*!0JPcghiR z@XU=09H%_pun{Up+f*OPW@kePXew3i}mJNO>e7* zHXYct_h*BZT+lg6*Q`|27^!{-epa53>Q$4xa;|snA|DlYl$Rlh9om(bo;h0L?q$|C zzDs@rmOC1Ec+067S;Ze0EJwX^{DwtVF+BfS7btrWK?r>D({$zubWb=o_Gxh=JA*2o zE*=m9IuO9qXIwm%;yq@l=VDMr;akbkY*$RwaHuoF3^U@E5^xw&jN(~yOKD@i!WR-Y zvp6PXh)p+QJ_q8UK8=Q3di$`wj0S=bHaM}{M9sp!#NeDH!tx_ud zrhtAn@2#EE@5x}#k#9GAL>c%N9G}{D9lV3j#}x=23FAeQS`dHboDB93MV57BW6##H zQ%MG|_mrzqo10|ca`ARj-=%XPF6Gq}q*Wu}a^@rtYs=!|KP$tV<=!YY~!Y+AlaO4k3T`BMgcV>GViO{nWIh|!c^~y9KQ`OFG z7-I+@TT0y43SPuf^+Nm>yFsNZ8B@G^&wv-*(vux2;q&0$lLXODWw+j6&qlQKs85)k zH2!eqM+Z2Y-K(^$diJ5JlOMCTl+3e=?(q5yB%TmsHvT7Gx2O21C~%28-e>439#FnG z@w_h*n}j6S+Sh%(v@p+ zA}%7TL?^`!CfRI6*52xcd*`-%8#@x4L|&Ahy`sY{N!b6ob88#bX!}CZ^FSQ%P1k61 zg$>WGImFZA)|9*ZY32=;D|t`D&>aqDU0|nJV}|5H>R;jL_dwc0D&5(CPu%?T4kgU* z)CvBD7M(8|o&0oF)5KUzZ%5WG;Y!Q}?7oErB@Tx~3)dOX#wL560xl9Oi(DngC51RN z4i$#(jGjB$$5^X3G&bg`wZ*UkBl+WexX2ROnS9>$`QpVE9@o^8Zkm7Bh;vJfvPONW z=Pt7Bd3E$CuEt-dsYB>NkR0LClvbApmE=`tbuiGKzdLGF&=Xu#EXAHGqth*Sa7Kq9 zZLixwdU(S|3_;6L&@ideFpkAGV^$NeZAUyS+(?H3)?%Y*bS~V>%M||*b5lWezLv0) z{u8JmU0im2W4pGV`8=7+uvQlzmB=9zkhUg8w(t+x+#@j0&J)UUG+G=X{*hrBMzR;j zDe&+@x`%(1)h^B0h&9XTi8z~J%;$Pc!}9YJP4r~&Tz3kG?8V+s7ky1JP#_0SPJg{r zi1d~junKyKTs5FQMj=w}D}wP}S1tM#WhyNuk=Pba{Xx$o1x_f)Cn- zWe<%FQO@-6%5wjAT07VGR{CM}Guj2wkVnuXVTlQX7zf%VAY__maP=^lUZfNev^5UC zXrgCgF+pwy*31ge60`N~U1yV)P2~n7OZWVR0}5n9)Vb@ZVIeO{OhGU-_+b@ip!vQKvnBC6D#H}SL;l=B zZr<#(+c9Cbn=|%VN>Fi}>^k{F5%GGO(7OQ-=IGXV?;qf6ETp`LGdXHtyq9>X`hVUfgZt z3ZrN`E}`1ngBnhjij1R=8(iwe;^Hb6r3z9+K3Y?u8@LLBLi#v&nC9al?1bD4+;TtH zx@e)G(sBN2fAFQrogug}d0nxDh;xCFOjM#sQ#ds0R!=_a=6I`-Y8_e-9Jng#1}F#M zk;L#RzIr6vF!b_mKM;@F>3i_utnE%S`XN6^s($1J1J>gg^QK_J_lUd%={RST<$b_D zS@&zihm#{Z4g+rguv8yb; zt2f04FE%gf-4&0Oex-eQ|M;vC`6dUegx~Gg6<|*Sej;u!W^*bq1=5)Jo7K+B9Ku~o zxC{=J)}=)^3^9GBbouQ3m4`RNhsIKi9?fWMFu)O-qDFk&7ft~B8Hgatn$tAG2@y4` zm-#6x;>j+?YO(KslcHGNsYEH+1&56s76d4njo`vEGBHb*McOgrKEi4rW+VUB%rf|A z0%qgpp-AXTsHDH*{Oo7bmS59(u&$bc+|QWyiU;VL0LIi8#j!&HYiy&>$6qV-uDD8G z7YH%n`YpPu^@;it^~iw}hBs{r3ON%S_kVEHOq2}Y`&#^tqI@Z(4G7_8(J&AcH-3;@ z{wF$*fZ<1#%$AIei76>EMyg3h_&X_fxK=Uk=Ihj$H`+{3QEx5~Uj)4$b-iRyeOmX2 z&3d-b4Y*hn4S#}oVnwbUWQfvOvH{-fM0|W;Ryh?eE7BeONG)@ogDRL-*qB>$kR4AH zp_8kO#|inQZj%NfCiqk(aEpH0B7p^U&Tx?U2NgSkvc;kJ8oli?(Mb0rvMTwcPnrNRv4CmaD^4fr;Eyr4G|o3x3!B zC*P4cDPmeFR@d1N1ul|pb*3h~uYRrCu^T{oe#~#p4jGU4&9=UgasnA z6&oo01`DXalaRQlOm($1Oli7u(5k}ZnHfCw6;Wu3$zh`|`uI&*Xyycp^lZqQB=s|+u-0@$)XK?b z(@2)C+JI!=(2U`iD*@Q9%bj0w(RS9B!Bb9S3s7vc&s=5ewZshvr)h03$B0kShW2f} z?w2y@U>6-r_%FMY5%g1u^jCJenmgphPkD3`bvOAQx z7E)k3R&$t3h6!fJ-c47m>$^qi-%#x}#>?GUK&La4AKsYod>+nKVvamr53UVAtvT9G z*k5XiEPk`uutwCUe&TjfTz1oBoi|Ug_iEeLhrUeX_3qPM<*zNPpKpI1occ28pRG{0 zN?vX^zy$PPo=6JJaReU$~qa`ejk(&Lp15;l;7$;<)NC ze>6}N)N@-r=6wmTwz5%d&7?NWs;s_FULI(=F-fX@6%+be6EMUR+(MQXo?+&bOTm+2 z4?6PIo0J*!iOQ?#F$n-sr(*0XgpRA-Jnj8>;d!wCZcIIILLJQSy=%mg5zt_Gxo&c{ zK^`$=5HN`5EVVj1nvB{ge#ut$>Hi_^&BLMo-ap_dADR{_Ly3_}7>UT1HCjG)VeAH# zeJiq#C1q)|l#s-bea6@s`&hDPi?NMejBV^@FqUVg-}C*MKl**Up6mI?b*_uf`+nWq zxzD|v7T|A+)nd0v>K|4foB&)6ZGqQQx`fu2-#qh&3$4TSNrt+)tc%gN_uNcVpg%IPSR&|(+v}u((KL68880wB!dq^M&C*UmUGuTM=qP}caoNFH7(}@ zCl216TVtPatH}O@W^#F=*5`$7173Xjf#GA-kn0DC{?jGleKga4rC>JRY*9w0`U*j9 zY+`?};C2fs`qxKvbd|z}E@DSNVj6*0zZkzXaukY5APaH5S3v|2pS8yy@LV zY72=OuYTrrBijr*+{cDkA`9De%<9g2dIi!mIL4-W>p$JR>j|Cj*f)ae_i{7uH=Wr= z7{5jLXsYj2lVWDm)VvyI=(ENYwgK$SA>FrquH_nwwjdGvzd~1FH~SK0jrr=~`%QpT zTGefDKcPNOJR1FBdI=QSYrN`B9~D=Te~j)Ji{g?0@}mHKB(Md=3Di6n>|(Mm<037&2elLq?D?Kcw;pBXUChsbg|Lm- z_sH$Exn%2yAw2X#l~F;Vf+bdO>7&*g1E!KcoeF&C4$wgf%<_D`403G6V~HNCM_z@- zRhs4XsjVqK=x!ao){pE8Uin6EVmZ>wqLR-Mjk=p+Eb(|N_Dzr4nyQWpgPbD1_S6_` z(l4O??I)zA8efK!2_jNmr?waT0T3GG_Qt8WC3d?~9L*^CL;2b2V}bJp&S9bcMG6>s zjo>!IWHKBA(#C1Gi&igx_l7Y&Nnms@nU(EZ&P-yQ1i+e|TfW@0gCxQ96$TLAJos~#OlxujnLx#PJ> z7BR|Kt8qbbON`w3%cF1Ix3dkgYUUY92F7Y@N4iy+uZ7s{c`q2FuV#NL&u8b{1Uoy( znHFDbc%=+FjV)$JLIz{@tC9&$ML8($g{ucyFRXS}1;!_k;-Dis{C&CCg33Owk>$SL z=uIIjO^BbM8?{|lfj;ZTwZZtGx0vhpW99;LZbRw~?>kr##oV(Eyq>lneG}a3#qZK1 z6jBWT7Tp$lX=yFaO$_HWPxjxR7+q0}R6+rYtUX+UZuZ-BhHVVCo2P1*F2`!>POC5o zp73feDu=@jG&YkauknpR;c5gi^NFjv6_db)`qWwxSw?_Y@pt=@CqIjxR~Xwg*e^|X zeqaEJnw+Kgw5w`=1#9sa7E&|IA)CSb)zin3_!zj_mao@}Nc%4dp03$8jR{4e2*2u$ zGWE5tiPr5bl2hpohVuILT*cB@z|Oj4dleT~je^$pFP4{`t9YX#r9S`G>zhUk{a@x% z$r4yfmysNEN{!LLUHmtEP~t-$%~@#k6V)pA-7*Au3{J4z+aOa~JXcEOT|hNG_}i47gv2ERukf7Dp2bVsur5+e0%^f z=Je~R)O4xc-QN~;5a_YV8LMDCDj2;PSs@>xri&4K&fJu~64yBkU2z8xbbh{S998mP z>+Q9vu2z#g!+COy^oDG`XE<*-QT@|%rM$N@TtQGYVRyG~`Jbg68+Bg*sZ^oqL=6Ab z7~c$CTNwP+c9fj2xdcXtl;kllm$h6zQ1;!kw51L_>Y1oh~X&NLHldwk^G%GeJ)6?joN_Jedvk&_>31{JXH{H0-G` zgj+tDzuqC+ZQqw|tsEM#=%j%+#-~K&At2y;@y^&zei3P#;UEoX^SiY&xfaD>Ht_X_ z{YakuXnB_C^7zSO#K4WPg@Gc{0~c3}WiopHI<)YkPz(P_^fn6Z9d>#2v{7LBRh`VamtGlF_uYk9`#c%h^47udFO`caFVvGvk2B4k1oPh$%fhqwx!7Q+W zxPWlh&l~vppIKsk%cCY*1~(SqA9(jiSmllu`u|db8kOc9D5P|n_mK+r`g^_STzExy z90m1q+%&iQm4|V+1VoH_50-%+fQy}zpB9q`LfGApcNSiEuCrfYpeRoj5Y8vk;`H(e zJ=3KZ|K*1?9BBzx=iD%URvjYPMd<9(TyaxUg^LmsaA1}>bpCm)la?dJ9syD>VHKbXpE8iZ=B z<&e421!-y~ul{j&97Zb)j>48K6Dr$1UAvzP*@{VpwpT}&z^pTmO#5Ar^9WJA#r7d! zXL|$BY7PoW@UP1L@c`#w#-*_5t53`qUznBZ-gIs!&Y=f;_b2;V$DCmxg=%x?^7%kp z(*$z7AYqQ1ASiEr zp$hF}Q|VU{-XWM$bq~+I_rsQJv`vp1Ua0;KFADPiTV(M+oGPP)7f$Cd?bYWiMIB{~ z$n#!j57IA8s~TB36UyayYQFzCohkvkuqXYjU~`U?NGP_6>UvudiKYur7p~rEyzhT& zs4v^-F&3e}N?>hUS-A3@WD31|xcwhjfrQJ77OoW{1?OmjIM)b8 z*-Kf-w^W}kH}xa>zgivBrO1AYqR$kc!TX#!i~|SWQ}=*Oty3)IRnsGy-T#QIxrF}M zwL(JI(?>KmzQ`HqrKn@WLNWg`x5l89%ZE7sxT-0kaAep+nMm_n#hkNL=~+^>smwmJ z?EGISS^Gp0o~-z=>2(@!6VFcBqu7IDyuW7l43GXz0SYoGdn`)d_zI-iLq>zD)hgfd z$JLjLEGKGcaQ>0Md0`ZepwC3M(=fH!iK-zvLKNwWqQfNmUma@cpH_;aXD*4vc{Y9# zq|vfVYScX>UQ>m8mPe3AcWAhFxSOH`D`k&UjKR7}hYDn21NeUQLs+QqiKdE1jlMD#-JD55qs9%&x$cHJbY2NrUXSBbDgA*5A0*r2&<0D^@ z(DV#|C*{sX7T9^L#LU97)Am-ikr7;e0e|Bl%^A239@ zbvwoC@H&wiPi1?c=3^8B_HQj%ONd#`Kc~8837aKfOw8rJBq*1IHl~D^yxEZ9E-&UX zN>5%2g*!FAH;NH9{|L!4Z6S^#-vEVUIL*biF#0bZ&16dxdpa>g@8jHjIoFJ^tw5(` zxp>3;lV7cWe6>c7 zgN@u4N4*(?mv?ORVEp0gO#MWcQj(;p$q-C%k5UMMl3K^2GRnG_C14$uE7!9gRw0T9 zDzc_K(fJgvWDG20v~HEL2^oL4$7VZMi08QQzGd$`JD5G_wg)ATq-&BTH`h(Fz7cx9 z8HK>dtlDC5%nEytqV^N*+hT-Ccr6Bp;k;^W_Cs;Crk{m#5twVi__1&I-l3k)>Fk?k zog;qeKK-0iPT1Y4;bRm^lfW^tZCv#4#C!ctw`C#o>dU?z2VZUt#$4CPR|U42q?j!* zWNe&w=+7y3!En3irmLfaoy}V@?DPG|>4RLSdjOYFUEBe&>HE{%_RUW3tg{V!ZqT+b zi``wz@nOqt7sPCEq#fuA9-6GgfYL;9$aidJKWRBTrzKRsy}iypv~_#|Zt2ixyore3 zGYrf2Efc+n!Zdag;-4uDJqZ|1OTAv`TCI5nBfOaqD?CD)x_@!~A9@@=3-iDB22@4H zy>6SKQSm=JhaQT{UAndN^_fMmmi(4&QP}njnMGf^e9BTkedET3#7ZSM%2CKKYWVFwszWDrCG7smu;A;k`HH+ziWykNKDUK~4 zS#>{aEW~WA=fF1{h;xFRc8JjmXOGgbuaN> zpDA(hp=5l2Wu#yF+6cuhfF2qy2Hi-IJyJ1O)BQ5|o#X6Egz`8f5X_Kp>)N#3E$^8u zGi5JPQRqzDgD}uzc))g;5OEb+;gK*+BBvFN#fKKlbs3k~RzJKXIi#=9zqKdsU$;yg zC36q>GCxESpIXZ^tAJ1X)>OlAXF|EZT9e;Ir4Oty%bx(g8yam94gKAO-Qb(>7&J%;({maG+T$1Q&^z*rb6-wPd zDSs9BeU1Hx3$QJ=uzs%)_aot(3S8W8nZGwzFW0 zRQHlv$@?dJJU_fF^XCtMvWYT;Mo1$PAV_0@+j?80-Nh}Ig9TRm{yI!g^)t2mPLm#s zZ+2?j5A67U+AFX|f_k(JL8xb~#AJaq&4KYpqgcE}M;|21QVj`>r1P0yk4LNa5e|C z^DVDxKPB>^0=F>anykdJ58%)w>rR8Q5>=?&%0`q-XynH}vn5gx7^J^3ZpDLP6mO4{ z=}h!lDrPBhfUVH=RSr7y%=Ry!=t^$!HgqT~{CXN;Z^j@UdXmhqrwXxxn4!~q9pc## z9ErZW-4j)nJKT^+g2K~G#>j*GD>&{)8YEjswb&b{8aZ72t})wVMOQNCzbV;8?N&?u zR9JvXjMXb6PbeGiFf%KHW-Mlj@vo;Qqdb1_u}BJ6|v>><`10rx!n+3qM_JH==O#pHrk4)<+Mr(ON;zHaQ=>py`!lr-bjznmod>=$b6c902Rn-j zq{;YX`ezwemj>*f{!l;K5yL@I^OC3Golkxq7@k3>yEu zl2N1tfu|Ka-h^szR@<1*TlL8O(kpw!klS2(Rj<1Bx=5D2k)PbLRDd%eLSUSYSzU9r zq%pU0wCPnCGTQ-vMR`jHTjpFrp3nv^mc*Cyf(_EW9ESZtF&qn)?ar}@1T3S&KXv|4 z!n16~sqhuWZk~L_?xfl)8gv&Ku&nwzUOLgE|Ll-aa{SoZSMK&{yAyoy&?9h5>Hu*FhupP8As7uG0X3mX8L;^j7Wx%dP6Ea;dIGZLN`bWJatD@1CTNL zoP0ESEky|lkVj1K$Q%s`c{+%agq{Ka3qD4gjS@CWe#xN011?U*rp6S@f&3+ko?|G9 zE`1zM0;xLQ^#L9<|1smMS2kf9`yd4n!0opaT!jz30s%r;H18ls{r(v=Fb`O`GZ2#w zGbQx9=TeOSh)hlY!sNm|9`j<`07AQ`lJ;DyTIVTzl1MBunXLx#o&#bDnXZjr_7ypX z>5$(G>T;HMjBMJ!GL>7UO1KD;z~T*n^1$%E)TDVXlI+>W^|xvrr|(GkT@%0WzR(Bg zJONqhNj;J#9{|X6U&X&3HOSL}+(r6WRXbFevGnO?Zet~Pg6%&dhB8VBU-Y7h0qD(@ zOP-b$<6m`^N;Oe^W5ljy^Xhg;ES!C`r`*09^&+>UB1OUA^afcG%f#)o$Ph2;?&Ho617qgZs^qFF2d+#rY>0Fn28T+-FGIG)uGpZj;c5ZE|yB@^rxP!L&W#RbRIE zVikhwdcT=WC12Xg0zK*_mJ5@aIjzMJkmGo^(=!L%RqOg=canjni2?vO@Fm}|S6Z;N zwnrY@4K`{2NLLj&2L$8@9P!=}NZ9k%mS0qgz6s31lHMgMRKV`(nl0;gR&jt+M}6z3 zC(1ITH>|I!hnJNUAEVd%bkv8jO9dH~n+2}{oWxCUFGzt(=*-bVxnU3a_5}c(W#2Ck($kSrOO6JC7UL%&V>uP`b$6}qIHf*)vRr*sSf$REc zgw+G4L$sH|O>zLqa*(?aDYZZohMOr4J?;yB3@AOII3nqMf+uvltodmFGOR`o?j44q zcUYa<4^2FdJpyz_E%T^AY<39|nC$MHO?A}B6)i}jZ#6!CLe2>J5k>Df=EXbk7Rsd) zs5Sz7H~_JyTRLK$`7v1$cy2t~QqrkPrCsE5WIl@g&C?@JVFd zGuFC3`5Cg?q#d&%LdmJWgR5R_sTjH(1kFQW2F(Tk`gG;F^6IbjR6lsE1>r~M@(Yv$5=nFx7m2nA_TkYcFDNO~u602-Y9-08_ zrHv19k>u^yWjVLEUZFDvp=7VU_I+sDqKpE*R}~5%hHWm)&o_-08rjR}qcT*mi>yEG zJZ&8u#+JrcKnH`Dl2*66>kD&zfQ?_U$PkwJx?pZ!+1q+Abzfw~p%cTj?8V3hj1Ns< ziuzbS$hL;lPwf4&0)wx5;{+4tlFhX))XV$!W1R3JXHVu4f-xo>og;UpNX8#quK{>= zA61dEiA^WvXZVDOtjzIov)7^Rh2$U4a3Xcmz5&&4a44bWKz@C1*=|hIW#+tTjq8?A z^q+7i?~&g05enSuh*uOixs*OM!QM?@tB`!Fe}Xg<;qR17oVRhRJXHoxnrTo$rH^@g z+S*!;4jzpv7oO~SQG3NPo6$OA6C4;99JzV&0%>H6<+AQLaW*_O_-3z{<_-)2$u(|J z{lw4Ks7YrGiGxU)B+qT7#td^P1TU}_=)QL9B6A1zjoGI`y97Vqk9vtN7lssX*p3+p zFsBPx$km$&2@Yf_mL*0ASO3J}9YVpO0GkI9{mK--86rGuj89qF-NLUAQY`glgX>#OHhr&;grIts$E=^M zY-VdD;%uC0QD!@FQ_tOyM~^`eScxsV#mjr_+CpCru&$RwCRpqpP>`dpV7fJ}q(jrp z(`d_o2ewuu0y=fE_f%jToNw2eH2N%I%%P#!_|eXIN_RTh5H%VPyCl^TyE~1l#U`5Y z7|XFkM)c|C3#;yt6We=2LV#!WAQ zFq|1^_IxzUt`Gaek6G5LNA{NISVF%^%kw*ILIw;XkbK>Sdh&Ah9hbDY9WR+@5XH(m zlZ?JBvwEn{rcdVv>F>P~6|2+Udz(dbVwIa~ z6%tJ*LU2!_3eWdUz$-*edS5X@a2J&LYbqjqRC9g(G4sVN_oXw? zV4aEjts<{g9r74KPAR%JJ{NO6DDzebBX_B}EsT@7b`Cl}*VemF{GOAbbpA%QaFxE= zj>)o5^U+Vyi!TecPD5rU7b-6d9SN|(dogJykJkD-MagoeiP-Lt?^()28gKz)a#cH4 z8C%Y4KNjLZBEBi47usR#hRjD11RvkGjU`nPgxa}A31cnzgR;0N~?=500@j{s!mp|1^sdR_POUo43;2zGAR$7m1- zShD+EA#8rV@N@0E)r&rhA9!kVV^%`9x49>=>M5$J#-1?;H(%6!dKa4-L_=~Q{EoVnL&i%CVupu=mA$v}ANK04SdyPy@*eIXq zt#GMoRE@n+-0d1X)!ShN9Mj{vzL)xzX%lLN9ppmTldd zh*ek&j)j@@Tnno!Yl@xT><5GhRBkLR2Y8QD{<8yP{X5*-3x36S4c;x7UF=m+PRr}s zlMfN9;z)Y=rR%Ui`4$P_oFqX4*sz{Ui~!GvA*k_HB4S(}BU{A|MxB$NY#VQAJlm zDdkA772?PWr-6lzQx3#TAA1+G2B@_kgH{^e3>du*7`qU55sOwfUWTWCv?&ta+igdN z%~$^vQ;fEC51^bjSb${sDvLwLW}phg^ug-X$Yk_u$TMmAxk`wfPVLa1@zMoEL}Tni z#k22>@L)H&sZUdm5hE8H*rg#kQYCC5N42v!9B1gIkIRLOfT(yL7$2Suj*OaO;2 z;>Al_4&7pnQCO#(5_yhaFO?h-A0M`x_y`l>l(_J7b zGfQ{jlDR)wN3*7%Y3{(6x=4cB4XF_@ELw&k-hXGiU;BbHy7AQ6 z3f8)?{%^pN_4qsa+M9DG;=-@D?7jj4+-D;e&5@xyyrux&wyj@ z)@5BtZS~$5B}oJCYZMFt4V6GLdp}#J4ZLrZv_Hs+8HS0ET`B3UR7x@s^P6m7>43a| zL>~wCEiQKQj0oEkI5hxk)ibCOK?s6n2!>>MzN3PD2!~}Ecxldh*&pZ9pj1Q(`4YVc zd)Le+hA8EgpqgL14DS}NGuzH@vuPl1XR+keC5oypv!G&e0pSsG_TzvIbGP^MaYNLKGQ5>RN|gj}bJE!CYqYBiwy47W+($2 z5fDM6k)bTej-LCP4YLm7a_Z1WgcX8bP%Y+qaX#pX(S&6>r4UzKV5NpLgy^n=KT;Bx za>x27)y)Ie{W6F8vsI>8Dh0=}zjCT4oS8Eqd1{q_C#>IlB;NUr-Hv5-X(0a_VWKQ@ zj{pNY>ILUFj;cZk50{trgW6a6YDmK#l=Q>>CX*R_Z=1=#5eM6n6?5fks7eFOMTxa@ z%xK>U0^G#J#3hsi{?BR9T=Z!L=Gy8$exx7m zvjAUT2Afs-d;#a(i=sadKvgZ@$*-3^nFW6JuJZCU`{U|jtiM85n)8RcVC9Ay8`;@` zf?%+Cx)Tm1F^6zO#I)KZ_*ZJ|z}})6xLLp*SqV8EykA&HE6MwON`@K`24K0)mVwY$ z(i#EsP;a7`l3fumdTH=(#aJBqAU?FFxr$l#f^qnm7a=VfJkpd>y^%MYsSVV^vul(~ z2wj{BR5Zg`Lb+}VYo1`cQ4qKs#uUvaX5X?uDd-YBpMn6NXYN6W+F|yU7c02^OO94O z%6j>Dt{#b4$!vX3scl{aW5Jwz4F*$=**Dt;8zW@&oeAG&Cg{R;v^8JhBx)3d^f}Vc^os69#=Y% zzKA;zVq~~C+-^9te|3ACCB7>IS|JZE7pn>1?y=X)J3=uq!!v9P52u-!iKqZYo*4jMjv>ZXwp7{Cc6U+OU5%G~5|LVQ&#V_TmMAb{N zgAJQC7k%_>kLGr6dyXAA3i)PVl*n{ITtbXb6il}ft}-_vm8@o2Zx;lG^@Y_0ZQwM%{)Hxu?^ej%H4UKlGMZK+_h=7r^6{ngbnw>fKyK!jB>Lw7oGc~nn?CiGlJtLL@s8d% zVvCH>@mxO@>&=v*R1_~u)(yN|tQWJLv$+tImuk%Zz*41_|H;jz3b=Z-Eb}lXxL79J z{o7~@*8pI(9t7N!D0-m}X|vTiG5#RYS0G5r1vA&$CF-?U%1sbrK0v%p9qM_2 zU3@O=V8#&Q?iBV2e}*6|yla|OlWh>mDY|hbw|C%%)IH#O@8!L894ttCffBEMVG0o1 zB&#OpJsXQ)zGGN?`-aiCt^20-mU4~C5kSFD=!>~!Qo{}aO!cl0H?FCEkPC;_&^@J1 z`T_>dS8JO*2}VM!o~FT@7)Jf&0R7-w$nmr#w?<+A zGb;ilF_Q9Zl9O*sO%+3wge}`p9^9|-4X8AG0%8aJhiisz5#h1; z@WH^1iccpix@;83yaE3RI*zu&KdiG~KWRBKI2sNei|7`+*Qo}%jP;D6|IUaW?F6uc zSrY&h>&l__?Raofo1x6I1~2@zFseu`jIzjNfWU<{sq~IBbS+z{s%9>me!|E4Zma|B zDa{hf{CATtGib1COBZP%Szh!gR4Ob(=$c?s&If)ZV{Sb$a;>0O6?t@pB}ukP`8uG@ zPRA-Y7V0N>Y(9K>_@-Xg*E!%72!rEVZ@?m=t>e@kAcKSdssw@?_O6$jm{od;(3W-| z!Vqh&bcO)j*?mM*Ej5E(dp#hQ(!rm4_lqoQ>HQPis-l+!d5XSix88w{X!dkXaKl7a z-my&1dCU#k4W)(v*9HPu!MeyrI(aBUbf^U>4gSm;96rejxFql^MWPA7EI}D}0tX<# z@k&ns7tDP3?JS4gU9!Ma_RO3f(&@@fAF{9oh}tX&p_Xy!A|iloEh+NlXMil?trbZo zm!#?(tjwfCCl`DTSPF@5`C0J^ko<#@+q*;W_@>lYu5svsyxuGknTsjzLlHMcAoU_S zQ5l-dcQi-%5~?=KJG4kHod!EzCZiZ73)MTfH2@Fihc?8-UuQV9u^WFvGPqQgi)&aa zLeBp{M#)F{NU(zSMD%uh_P(veBGmSG+qgl`N5q1d+?Q>y125^;lv%#=@fcERx<>za zZjUvGYmO9Y?D7C;ZsXmoo?P(;YNvSZL?%5`|mu6O=yq$P4iI4=VSan#Z0dwKC;ir6^$&*GTR1oB0V2y)>QvbdN>* zHnVEeLG5i~?E^Ro5G*hO#d*SeTT?K*I~i4CPi>hzkZBc&6|hJ~XAR|A$py9ppUhlu ze;1|H2uMQAFVgMH>I1bQc6v!0DgoEn*Hpt0I^`xQ|CIcMD`?4)zl1_Fd@@%*uXy)~ zSp^$->J50$zScr{7mg^|Ql23{OH2!B#O|1l-6=QU80;@y@Ulny&)At|n+}Smzx`le zDBl35bMi9_wsJS`_$$5(7O-%ylc4|#IkE3ZtN$SuL}t#tfzea zSMtA*kGdi{$t^pe5FM-9x4_n5F8<~;u)CZ&4Azzd6K!p!)wXJFZ#unP73zUZ>_I}RPAjpnElhI;Y1dgRwwy=>`2$5JH4C}h0o&dQC z*`R&J2bdd%nV}+NReD#oL!?5(*fz;r^=PnobQ;v2g%$#~PZbBd2g8`d@M9o$Pj#yc)S!qcT@3b-IPj@~H

sKlHLjOmx zfaIz{n-_aiz!TUt6Noi%QD}St9Fzr)229!kR+FE1vN8BFdYiZedq&A!g{G?u#LrFK zW_atlsXxJ< zf2Imdtfz=f=>-VG4L(xaX_TWa7*2_YZ9db-dH5;VR`#CtTN>WxxmEUVOvdcCXI^@R zq^d7_D#k!>4?@@XY;2#kq`xZdX*xK(4`tHUv4+1ZfZ_gTx7DnrB<0#ZFFpa%FV%_W z1+p6CN$gAa=ih3;gjSO+D;dik>~I5rkSv_$o|?C>EZ0u%C#27Rw3p-7C>KujU4rzG zo;(bwMj&#Q1S#c_(?gx%E2>qiY-`;fl*$L}_+8S|A`CUJ`)@G(ugXttO`9n?gFB8# zmSj+7FIb0$z)8t0s@73pSk-FZ3l^WsIzbV(Rr`SW_!%GauYMTjqEgIGlNZB})2pg3 zh$C#lyeWRyO-lzt0#>p@F9e(*JcFQ|Dcv)n_OB4vKSxvWK7`sinr6 z_3_lOk3s2L%&Wkol=(53h+DF-Dj*ODk<>jR0($wzCDs7ykbP}WPW;$;u?lO3Yg!81 zr54%lI=K1$S?pBx#>(7eo{^o48uDp2SjyS?=S`sV#mU<50oENltv82b3Cu2!+bbJ9 zc5Xgguqw9hmqH{IG@1xSK^Q~;rcU#p)v9hMDJ3GlW$7=MC*Cf$4+6x^)hCyiknizm1ZNhVii$%7`Ogq=(^*d`)7wBc$Q@CTDtUaW8+v?YfkmgIS;Ml8 zNEkBoJ6N=q5V)0vDB|`;Zh5b7Zi_42f1|CU58vL1Qu0BpNjdGjXF))`U<%CmtobLb zG3po%U+9EHaaw<&3eRn)!uU|p3QpLs`+=QUPzkwaS*`eN?3*P)IbGJzQH)V>#`c)y zF&RpmCEL=gI;fE=rH&m;oZaDU%243j=NhW&{36%XcWX;z37o&nBrt^hV#Yn%g_eB$Awuc(fc|&F`*Ve``*Lpoe`0S-+xuzYpLA4-?I`%KKRhda4S_R0#RvefATT;-t4P%i3g58V@7W z!RqKN71CS!XDu!F&SF(1i~XUd>C4CDkU)=-VK4q)Ib>BV2bu`G<5UQ-(t~JAO3qd5 zh~8_(E+3_1;NYA-ZKIE3$M4w)AaxUIPg7~P zzqB2!l~X$7EBzUt?i~`xlzNU@H{z!@wR5o*()@y^oO;-s9{HH+Up^;K-lb`bAGk>k zj>FGWgX71IFH-*aFAw*4QA1?EBvQ7gF?fXrwX`ucEfh@c(4U!2p8iF%|6v>Y;i|cZ z!jJWh6}MFyk{z#8`*`iBRpLfyWzY<&W&4wu6|dQ6m;jZnF;V!~OrX3ak{Qj2kV7%Nc|p>XKpzm8tr_ zCj}zkOa6r&ikBEE^}HW+uf7Y=%xUCZq0+%6No`Ac5PqzQW{7|$6>vyWAc2|`fY}!a z(`b@wAhpiYMoldIU^x1N_YnFYSCJ1WrT3ZcKzsoW$<69i;ohb)H7;va{%<^e;z{A@ zpkI)b0u3D=c~m--ni4svbc!OkJW@N!{;J2`PL0z6?OK z|DP(RYu~6ABQ*TX+oBmyb(D3oV9#FP&eh*CYgJ=^+S?jxBCAwZ>TtWmO==+F&;^i=&~sMZ8Fqp*Wv5jf;6o9GZ+af z7!Agd9vZu_usKcz6Z#vBIGB_D&kzokrGz^7SOO@JqY+`*Z*@=mJzP^zJL7uz*MD3! zD^q=0mxWsvjqIP?qngYPRYQ!Q<#&Q+>#-@VQbIsD?ESA&{Vleu_SlZj@J1VO6Fs8btWJ(mWaKK~m>27D+cW8%^j zLqp{+RVqW+sV7yOVCdI(G=e`we7L%##l#Z#B_i-YZvlM%ajyQyJsKm4bf@lTLKU?2 z$Omy6k9T-d(X1}PDE$2aovI!DUv@EF%KLp-B&bvUi6%El^YHWk$Erk!qH+3l`Ls!> zvfrav;?!dJOy5I%`5*P{kdo#-inh2NoOcVRVUFVms)Id6EzF=_e~kVsn2S^}_g~d! z(SV8MqWYu+EvirQIM35TcPPL=uS)Jy!1QJ2pQ2H#GDE8BTm1$z8HoS+H!#ywFxyAm zylKH?QNcL<2BR0X`ByL%)Z_EUm0E9FFdDzX=up8(T)3+F*U`fgLkbwSsC+tFFeX$m z(Z9hg<>Tl72Bw_~W_{Mxi55&S6-@hYF!Y}^{<4MQB@-$bw)z?sS}=aU!B9s#o)9na zb^PVDpgUHgP5~3+oi9NP21*6f@Egp|1fKpcY;7*4f+2LdTGE0^pn{R3271m30wy$J z(;vN4O$RktTyJ_IcBsA-gulIXKGi8XitBwnNkb#erw-ve22ze3p_)e!8n3bTl1j)z z7&Wjt;d!M0^`D*5fA&*cqRwKIWN@c`AqUgY=)ayY;?^(Z zQA0;gH%c_Kp;Gkt_d&oV-f@EV>xcGmxRRhmr><^F*E@^pG5b3eoAV=0#$0*uVwp;( z@Ujk|p#Fg02zSY3!#kX~fqBg1j`(x`6Zu`L0PODIxIHHBjVP@=#2cpE7mpXUGL|x9 z;DP&0@*oXzHNW%(xU6VbEG&Wai|wssEDrV@S0XJf$(}pa&RC>@S~l)rgp^I*W5xxd zh-gYrAnxNw3G-sn{8dfgGZY25^*iR6ta)lnBiBR9X;uT*C<=i49=qMRyuod&CA;lA zBbaTzHo30lxWT*HRFUMK9R25X2_M|6 zi)feMAAb9K)BmWzrT*jDW)&Ub3qEf(;QP77!!|Azq(ofy-8YjZUaOCCPkK9KN@X3f z8bh0_o%5)iXv8h1L_8Rbcd2CckA*D|JQpV(Bo@UVc%t0rdwHZZ5+p{#7hLT#^#^l1 z9Y$wl@I{1h%BAS$?@Q6r;~Iv)xa3G1%EfB`f$|6$wVE>(80>NPzI0kAnPC$pQXln7#eb1dpBVz7j&M2b}SW>(EB0!okqZ1TAW%d0@R$ zKBh+#zW)D86vy=b!g`pQM?-PC>c>6uX2GL|kLU0dtY>BBXU{23H`^ro3=oHq-j4?7 zY`(f6)VHzh+(y;DDiR)xXpa^v1Kc(~!3v+~R*o_%yrzfRooHI^+pCsYjFe#HEonb4 zOw~-6-?no8PRE(QX{IREB0scxcnJg4OC0+9mddAQ2zgDzRqtA&GK~ArX`%tZR^0d< zzy0-hRjcVTi}lP3$1RnEPrFTiDh`5mX5d`mRXP9t^)6{KTw~uCZ)DTjZi#9C zVk@wJkeYf`(73t;h|+FS?H#CB#X7|a^v2v6_)?P!K4aGkR|we3(vK9g=_sKzT^QEB zWN;)56;E&@Q>FzCa*70WGmP#rUx?vJm5zGKtC*cProl+qRS-ydvN_j?X4wCOx0L77=sd9U{Tg>B{9bX#otJ)0s~ z*Pp((th+_`OiLWg+7l!@5qdelnws&C^E;XhrarLFOf6V%_;e+a2um>TyrZWF`a#~a z)$jEu{=>O}_cbjUiH`&JrMscN6Dke`P0klla!a^n!nb$1MU7z>hXm!|D%T_EKT^6| zTo^%KFE)J&wKDH+dn_9$xvLNiAcEMpGAUy{XJuN`f9u;Ls=i5Z-O~KKClrk2qmL3~ z`;jL-#+)y$a2oCIpsW05&g$dZG}={T$f(Tvf$@YHIL*AWVcmps*R>gwn2=iDfYmRR zSA_Z<>_ud)`4AcLR#@tg%2I{P37P5CDMDZJN^SLX0~NM*sa9>hZIvWy#}>fy-NiyRuu6SCnfmwcqi*5BaLsF7QPs*D1*yXYsVoF}|i4QIRsj=dby73thGK6PY}uw_!~=c)0q@qRhN% zrQf`m-e!lMX`KD|uCq`~Q$gBTd{wvhO%o`FnVM0uhBab>WJTz5Jz^e=9R!TuVje_%iaW4i*8)#=q0z?Nd9rEQlL{jVVi5 zjF0DK5zWUsr$f1$_&l%+o9rn6y>d$^O2o#ip?P(RFK9c4yvXIB=+k<0o0>X4W$@ z`R$?afdMFFmR&xZN1ppY^Ef>pyr9lp;z1oaGGltrhf+RLQpG^Y z=274584D+8ZFc2E2aOE)yf`}T`0X3<-MSAKOQtjO7RMXH`=R7?tG6BxrBTJWOy{v1IH!veFRU`9wNI9og zO0i{=2FM22;`&K1I-A@8F-GG6v36K|!+Z1MP25$j9=DmlH-!T{2S|N1#xeb=JMu!tS-0r_N1G~!n@1goP7NFzt-6h(75K^JWu3F zB<+9Zc}mRcM_59d!;J#}#AOBfnpmAVzy0O*Wp<5O{~paY()y$eKp z=gKh!HEa)M=8nu&va7t7<fNxZ|Gatuxpoe5L=kZ z`nD)zzS9QziSy<7A!kPoYH~3$w@Ua0_b`*{6DB!1Q3v1Pw>C3p3$bEmtFekBe!35p z(u?(+cV5-x$dRzbTUZoXz^2#RJI=d@^|tDLGK^;v(Dmqhk(ly6B0~P=WYZ}Q*lZ9c z&7k^EGc~}AyvXsbEyB1HczoEa zF1@Msa8cY=V|O=VtzreT)s)NK-D zBxj`l;y20uz#25>cMo8}r4k}$rZJA;Q4WS7e)3Dz0b==cIC0A;e{&lFl*5o@BiaT8 z;N7c3l~&F&K^%^Z5#cKL>?WG}R(on5K=p9mcVZV>gspQf_A}7(Z!V^0&iYvQcyE8= zgeoa1Ig693i!HXobgw#~=7)_#^ypG7#1?uFy;4IjK*ZNt(cMYd(t^vL^+_=RAt8D6;%CAYRY!J<6M0reOEAeeDmGh(>Ox9(qQ%jR)Stm+y&NUl2CL=<$ z8wDTMq=scq2i%=bGM1}5*ROwO-r+vJfkkSXNKUN^TGnu>*fgQ-fji}y->M!4<-tl3m7 zv`Y>ctxBpDM2MPZoTTNe5!-ffxGBE@vwEP#xsR~Xgox{M2)J|d z=w`RJJrdj@5~&GKaEWMMyRjC=4T6O+h#=hABbbU7!? zcz*3+#hTq~$I?ZwQz`C~wMprqf37>bW8oXQq}Zl|#?kx3Fzlh7(zeZSPE^}1?}m~9 zG>oAoK+Qu^0ZYFWO!g9cVn8nOhi4PWs!T2fb{q^ew@-)mEb!=UwX0?7T5T2zag?om z`+7?)?(Qo*cy*~e2ovpOcEOU6>Vj*mqPx;Gt3hm>&l>H@rDCM=0`a(C;>AohNcIajo8PNE+7?DRgdhM_!~k;$&%wGXdca8*t(bZqL+x9Hzw zjEm&?*5mg&-b!A0u$Z+kS6`R3SS93mWpmU5HXG2?9U!dqfR#=)Wqu>gw@Fww&(b>Xy>6Zhg zUp}%irYwF~b;HA)G*+g%&R~`>F~hW5o%RLbmHZTW(#z1&(a}@4WoIne^&UAa1o5|| zN{Qi`Al+pyfi=3o&SgJH%B6HWyZ1mi;X7Ne#veYp4!d%rgoT9DtE{KTUnIris9f1j z|5Aa)vyE4?@uVNZNVu#k(G{l}2H#Z~ImnYQ7Y%?oTw+wC?1x%-rX8zEy~p&Vssf4~ zD%5O?yT@VN$GeHb&+(`Rs2I=OIy9W)zP@Oc*AZb;+$i~a>v23vIZnLw+;-nlc9pEy zdw}wvxyvkTX*mJP`2PVJJs&ZIKH_(KC+C{!o&JcAJ(ba*eD@@c&&Z7%S7twK)mAsH z?w@jW_EXhZku9q4UdSV=gKx`q;n(s8!E321D_Q8bQoSH1Wuo3z_pAqDMw=LZi@o$) z346LdMt-3q3ml_)n{FcEX5i(lv@Tu|F+YaQbRE0CuI?h+>ef15n1;dD+OYx$GoKq) zB~sxjiVLtBJyg&3c{isj{ZcFdL97OzQTTeSPQ5jaf<4TVfs>Ic=Yf#$adMOxPcp-m z!zm+U1TX+uId2#4qttc)c-Rop?Iz!Xp6KS8WL73=ijp-PiUzuz&H6&M5QH(S#UY^? zdYoNUipG2Te0FWMlxgORZ^>nT72~fD0$IFWwyhU?<8j~}zEaj;DQ?R5D*8Dfq+6Zo z2>7^ejU7gxo<_mn0H_A5=(q@6PBr#i^)NOj0i_-XnMsQQj=1GK0cJJzBSrjD!Th~v zu%ZHv_`$cPwMEW|Yl&EDK~?jm~TEwRF z=64czC{)p}wH`}NH_VUlGklp*RuD1b)S98uW#@1~mXr67oUi`kF6mh>21Df^VR9Ae z?~+ta%#--=^}6UALHN!=;jFHm544Xb+Y@FpUj?Qi4h48kcepN8ef)Avl+n4VIuzd5 zrLJRgl8(QX%|HvpLkzteFXy!mD3Az+{!9&~4==m5-PzIEsSZF>2rHgiEV0P=Iv;Qb zTzdzOalva_WW2HX2(<+1@fxV>2Nb)?v5nNsIxn2+D=n%I_8?)8dLqIc<^eMFb4ok^ zc`ynpGWQ%|QRj??;9Vcv4L=Xa#aclSNu!IvQ{+2%%zL_l8{BXK+@zUF@=+#9QMR|%yxqz_z{g@lT%?bF zH`BFBR1nJc)%BXJB$bui?7HPJ%eiW84KNtqawfUSLxHaNQJKsfn~HU=w7BsU#lDm- z4+D?Iv1DkS=20$H6ii>D- ziomdgH*D=2>o-x=yw2>3%{j#LWNIVI&`1HB3Wl~1_Pz3W8s4H9fHm`9V=7;p#fi`4 zbsz&wD8$D*=jQL+9&dEk=dJMYUiBWB^{BiXm}Zn{PY>XN?^Yf^iltTjN7Eh^^KSV+ z%vP#xm3E_pQt|76d%8H6pBU$-s1`V?3p==hR;c$8&;HA|SCO6h3SPz(%+R=5Z2}kW zo!H^~(w(joc-~5>0$=FFq_3ueVR|a=bA{Ag<KR%$Y~8S%dS`FY6*cfn zH5VJLg^Fdifgelorvobiy;O%Edg4W&*4YrsI%)xmY>Ired34UNm2Q3%!0eR~d@3LiEBb z%NILxtH#q4#yMhKH;NZ?6P`s_=iH)qt`gIHk~QdZkWPGi%ic0)vOx3AvJLQeQ9|3? z^b!6E<^kIqq8eyYDF&A(WlJrannCp?2LqGs86WGoBv9o@N8jL5eC!S`Vp|xM;YRp! zlf6{YysqjuXqoFbnh>JFaC=Wsntx`v{+wGtZB5ZbXs}$)Hu72M{Sqw&ZHO(iqdQX?2QO;^`j;K;=OlK>cQ1$2#!7%dc~t=ICb!6x36ZHPAtq zo^sok;+GDV(SHSY$O%|gu)6^qW~i8QV~cC961%EYRd8oL^yIopzr0koxNG*H#U5FDv&3QY zQM{c=i5@L7qZAvV`mStj)E-UV$SwTYKxCtrLX!kpzB+h$wa*QAY}N72-wQCeDjx8x z_wt$CUk3K4PK8>MVdLw|y>3Ad>->=2+#R71;THk!Y-}XT9ek@s`^`_DyX!P_t1#m#jT}m?i04 z!tv8T6mxHxUk8e}z{aTfXuR5a4@sDYiDCv`s~E*Q!Oc>2KJo_gQ)f;gFZH2any4#e4Mb--M0^+P|+ z=KrYU4QNT6B~9hNlg`>wb`1*DPr-h;TH7J;Y7!yX4b*rWQNgV+~9 z)CF0`a7DxiSy-5P1h1V(?CVz^`x6*%+xux1cDX$Y0Bv+ z_GtVh3wYWPc{cvSZ<+FgZv92T2v#JrkGRtmdBD@D#Lh!R`Rq+f94MYS6}o(l_`5`` z7vRiEvY(E0kAVLfq}&B_OS7~?ekud#gi!)CD@(UK{!>$a`Q+0jK#g?xNyzyzi*WM?;8&pxA1^gTR$aQ~@Td^)cP5H6w*IoCus3~e7{DE3s;y-Z`G`Cj1{0Qss zR{BAxVi(w!s%SYQ(XmKW152T^o;X3AipcIgBH8r7?2DMMM~N!JmjZYiZ&ymQua^2< zV&>_)-)jAfAr>D66o!QH%I~`(?FI1QDNfklf+<@1%ir4;#zXXKEpwZxK@}tXd#*q2 z4YrD%iGlBY18Eeq1Cc^t>ZCqiwSA|aVh6UWcXfM@x)e42k*WYRD9^oA*M*6Ckux!N zD2T&2DhJzbznI$vGNR$&QV0%@ZmEb+SN0*~b5s~&#zd80yO7gAQZ!=o};lDZ&?UrGOs=y60mA43q ztLYez-^4{mx21H|q^bogSbsU`S_q@rjcTRPv2rIq#Xx~!KQ@V{}ERyN9Il~%<$Y#BV-$B-FEg|U&QLfvU zbd5)o5@PFIFnVVqYziLIL%$!O5WhwK_YPu%tG>5E3{$P3uNA}@=-Ianif^L1S)~yE z3>UT!+zo)pH?YYk{xKd^h|;(?<2+-_il9&sV<;SSm!nQBn_VqMZw-gk9D|Dq@eesv z&xkR>7tJj5SL8MG8%pPjvh$jpmNW~r^>ezVYRUGcIYj~lplouZAWWkw=Pq*iOI^=> zp>}liIPw*ZNvOwP+qBao@d2WzStFfYp{14L{oE#z*$~K3Ny=Qu^vrNup-rU*G%R6s zvC&l_-?Wik&8oc1r0-0u@~kA6?5=22G(ef|NX=(&Muy~fMyS$_&NW?rhwoXvM!B;& z4R1sATs=4dv}XKD2Rg*6WZZCeXW?$1^$?q`$9mVz`H_o|m~y88Lf9thM;oM??v8FQ zjOz(Ys?)N_P!lT@v;-#Nt;s97FO{@x!1@%kU00EZ0;kgpp^+X_$HsFj)>jACdIqpH zVF?K|;`l9J4cpprblmY4E+(5PKM*GQYnp@=t7tyZuv5ZZP)*qwc}5PYSfB7SOEeQs z4hj1XdJHHow|nk-BUzOZBqD|u4ljex{_2)qp!!ne;ritqRgc(<;NRnM4^UhUQu%h1$$<1wPm4d4N7H zI{_148;S2VK#1l{paX_tIJZM-lW8Bi=9_h}xG6N=BBNQn*CdP;$^YV%jD2%HMheps z6=yZj|GCUIGe{?E9s-=!TMwGy6xHc8UZsBd&35)m_y;$arBZAK(m%jPaN(7XsUcb# zp&aV4+9w=R*Hz+_=y8(WIZIobVdc@f)uh@n{EO53kM8Z=`UCUt#-i;TgdfdfLh0>LSxHm3Gtf2^sAG?;%3dkz{xM`O8y~_+^x3^){S%Bwhd}; z*DqBnZYeYmVx;D6!xLhNU=@# zf-R%|%1)&rL-0m?9oc}5^2H{>57Qr)R(q$boTt;_#vh(hihb3)n)YOP{j3xz%g3JO z4h5#v%x=+wUU&42u1n=YIR+<3Eyd(=Khk|FtPiGyC!`{3da$5gM~rw^apxNR2$@gm zTnYDv_=+rbw=AYf9A9Sp9h^@M?CEd9$9t>_Q4APd#ii8SK?e^C;EF|o=?&PCByX+7 zKzmupgqNQ#x|l%*i)C*4sH$sTA&-QaZ7#~VNhQhW);>LuS$p6J!^4X4cSFSV$HoLU*%aFxf2k4&`%rjErG{)At?AyJ)3RL9G&DdN~A|7JgaRF1p?0}L;sLey<)BX zX&N3Jt(-$Pcd5_F3iA&?-oCl;oN-+G6}nU&YBwpx7|Nk$Cw-tHPrO`dBv!i+g@~}J zh!RydM?o7M+Y)3jGiz%eV>me~0bsHiOZUlQkl-e*Eq8qGGi&6^Re9v_P4LFSXg&9J z)tS5{-EoX2IBarSjZ*BwbP2eNWodJ8A9UmGkqaHLMX`FLl`ggVgYVWCz%IGVx1{ME z<{yqvfAmo?Yg%W2p%MsN2>RD{E7$xR-N=?n z{Ma)`wGjEPik=;GqGk*x+9j>d>1E#a?Y9jh_|3FsDfT5Jsv_?4nUtb$b=o;tvPt2) z_AshL?Q{GA!*xTnB5S$MBQ^mws{>Z5y0?mLrFh1%YAc@gl)>&R%{baih2VQYa$Aj_ z$OU8*ul5$Q#Lx)bk)3oy{ci0g!#7Ws` z&6H>dfKD4V%IUS1s&7F*ljInGLb-10*?#>XnzKNkh1bm<$PhL`)1w^i;s7QlioD61 z+M2i8Z*dpdA^){5Jb0pF?OkOsoAxlx^!wGAg^<7{na=fSlmLS)(!K98B!)X5zx3JL zcI1|n$%n7A1w%P12h1&>p6{E@$KBF=Vq3n_?T_{sydW$P)q&mdj>G7+$Vb>BhYIhK z-b++xd?`DSykSiGu|)t?mK;{Th^_^k&@Y~amYN`NL#DWyNWQwfvUMtWIse?8o1R+n zRJT}99Y^jK%QUV<7+cF#IvZidWV?1NVSV@#DC~uBUiWB7Hmv~>RTKj#qn+FOJGVMX zeMN1|qXb_)j(t>nJOQ7Zx5^|?4;9^Pif^+HH}mnfu&i817Up89CWWihVHu4XA-BWs zc%Sr@&u!L?q6^QVd&$g0f0EEI_iV^ zdZjNSnpSb+@=EWN?+VpSuffI|daAKDEw@PprEIv=0r2hVsGH+s=$wS~rJajX{;zQ;JTtY9!&_QUoCe4{Tf#@C zmf)&kGsJApwhJ?_V8Rpg>F)G~?G8zgvU8zL7%ooi(B{_l#;%*nc*=fRWK8fS@!3u^ zWV>A{dUBoKXbWl>wVriQ9MFM9EB z-^1YF@iizPZ*$8eyw$L6l4v8UmYNNwa9=fUN&LzE^9|8SF_e{hGfp>JQacG}L!AaV z8`P%KXwLq7W?A+8u#Z9g3u-N%jG~#pSklASItTO+^@Vs=ukD*DEe7hh^?Ac)ovI8p zJyNx92dXlJx`TF{IJ|vk*ScqTZ_AAmZieHWJUulfemG~wP}!gh>RJor;~sas+!^s) zs${Y0bN87?*R`-?L<89}ABBwf*Rh0O&_u(jb(mx=7pts+k}PRLHEl65R1K_}aIQDIZR zOY6v6@45PvOWlr9qpuuESZqqx3(~@k7W+-HL!$xHX;jx+db6GT?-nj?Ci6zo^&ke{0)1=Dgzcku@BQfn-J24I}cxxfC?HR(= zuGPK8Ey@24PQ2FBFJ*xG5)SenU6@%EDpMD}-P~(hc_$ZZf!^eLpD_&b8_j$yNIepk zbxd$Kab>=v{=(Q-mrFSrj|YDVOg`hhF^Btl2L|akL#UB6;Xj4%+y?@eR3-!i+gs=M zf%GJ*53_M{toPFC)!M>X%FOL9A7%-(%YVU=D#WwiFOKp(kXbp9g%|ReEgw|!t!bCx z5P5(}3|y=-(m8v-l0(mR(mET%SZWl+>gSJpK6NbfR%g z$87@w>J~a~C0j3eJ3UgbdVe+$ZP!1hmBEg%(2XP@|Hh zr$6$127Q$j>}gq#3d&ZvO6MqQrztmks6w|E8#8m*e6KczRkp8Nq!+td7W7Hxe~EXA z8FdreX^9fPmu+sEjWqCPqQg7y)ZWC*L}zc9520%U-Rdp|i0IBJVW6a+5}EJ0j(gNf z7%hA(@yFQr;O4}x^+eiJmYNP^mTkCxOo{OgN|DzAae80HR^)DY2Ax%!j?7b8CpoLj z!lNlu_jgLG2=`<}L{n~Wic?Gmu&xd`1!%GA+D!)80wwL%ToA-YR%n03o|^=1ro|gM zp(f!4eN0Iou{S^)=@aTVGny$}!ss){Ic{tRD~77FzAIC|uMr;ZjwMG@UE9;6z6{ozv6j-G1lVoG;MArp#5^q@?)= zuej+Tu1if@kbl4-esPXcSJvRm5>oV{nx=6AM`&npr5G-(a9U>FD@aGBV^hcuE8Pk*{J;j%tgrbAl;Gn`kTEC-U8bq~ZuT-@h zcO2<&Ewd$tQpLD=ppKESET#CF;)FQ6H6UF#SBnC36L>LUrWv75(JoVE*8P3?(=)c6 zZ@rBW)1-H)73gu!wsUiINV}NYgwM(=DWifeH=0I8+o3Vqb1#o`mpsz9dvwlfH!g1d z!&9YPSam^OH3M6UDG0SL!K=dQuZ<#l-5VKlraI3q&rz{w=G{(bhvSBD*#PD+fmzSm zTX7VPY-z?UM_GfQ(r>_~T+9Lkmkop;Np}1|I`Hts{lpJc0|1}o*YqOda(fWu&jF9F zr=f;jSVBmXPnsh*D9g6#rX?6dEqe+amwVlJG%Q|e8m0&8W!P>?lgcJ~Qr!uxp9ev< zKx3Jb)pg9mdf-P*$P;w#T-nI?|is5=`fiy1Shq{}G1KsdjS=_J-=i!6uMy$gOh zXg(d4Q)QfD7{wOt# z)KJg6L9~|nk4)(3Yk)fP6HfX0-ttW!TS;VKJZy8)aP8&k1&nx1xN4$2{B>LAvJ^Q0 zDKi`=Dda^&H=hOAR?4Imex~lbv4p+k@}mA244>?{z%ob>hXExJhuqC;*84=wiZ%ps z#GmZ(4O9>+7{gQj8_6!taB79y;uaB#vtDXfk1%Hu;FbEuddoVtEar~VO*TV`Y9nY_ea?*5; z43!(GS?41^R`K zM^oPkzQL7t>u3vJ z5&9CN;?6Ul#CsMdpO#{TiO7p2n|AL^kDsk;mvLfelA#mz7rm+!%M0&PP2jEc zxW*HU)sFsNZRp!9&~iJS5Gh+^mR`*$ ztx%wjD?%4c=eAl*;U>gU{^hG;SFGx65saEzCa`LbmkS+8am1u3(npHXMMRi|C+ynV z-=b!bVTJ|V#FqKyi0gmle*f1SQGcPlE!YKA%y1>%}Nf>d1T`(jdiag2vh5q+qvH}d9E+5JYPB=xC|e3=mEZ9lll z`R94qj}!sPsxaPJ;5HVLB))uoD{hQQjJ;E$m!cA;Yi72<&Q%&KX`DpBly#g?+|w~F zvjsI+$k#W>T%VxHNI}dDt$;4RM~SA-KUve1q<*FLB{=Tsxvi)3w&jvW%fP8 zs;4~-NfQU!7yaAoqMU~4Fp+Ks1?*8B=>u5wkW%bL5^?467C!LC)V*s1ySOnZIkw}x zmPPefxpJjS%@V`Pe1lpTg&ZEctCOm?+`!NW!qV%?BtXzQr%ec2CuEEE$xa0_<_{<3gq+hA*R+cP2M1!OAnb$7Z} zEr>Aae7Q>`ntE-$gf{t%Fk^qR5by}WSb;eh6M)PI@m1AtgR5KguF4iRwhTyV*_9U2 zJ9&txUVh|M-khsAa{dVRtnh4+j>o61=p$sx%!_q&85~#zIx|gdYDNk8Zk7oq%^P)j z+$7xU1c=cMIb?qLR0k-8IHa6#0YQ~9P8O~0*cBwLdIjenC>_MpvDi`jRDTL?A2WdN zGmXi7*mrdZ{j!?eCrDlEybkoQO!uv;^I>dH67?rzZ^am4K5k~_u1;lRE8HZL`b^Rt zqa5ba6BZKn%~Gy}Rq_uRJ-a#o6qe%?v|b@{O0XiKjnzS<;%wtcBp;p>Y5H;d{7X@7wJp7p1%{CTOv zkpM!~zjfr=CxPswyiYQ&w8J`X+fMqVdA#exH}B7Lcxdga`NoBv@&@uH>&s$Eb+l`kk>31;|`6rXe~#L(FlO z{ZAGffGwxVq!x%O!xbEyI%0-3FD>hl8(Q+o3ngTKli!+i7~m|+V}v87af8EI>t7*P3Hvi& ztKE{14hkk1$3-;C=;th$q}(H6p$q7W3cnqjQDvn3x?1#SMYdTd_S_p;q!PgnaD6vC z{(agN(vO#mal#{6=lEy5d!6G~(7^o7sL2Na)7Re(G6*%Df?1dJzZ+~G?J#+xdJ&Xo zZzxaR`r9{pvQQIbsz{J2OEi7qKK1R;*ecK{9L-5F6nQ(a`5KSr2^n46K9cPDFO^Xv zWhxD~s94yISzbeOK*^gmqLt*Q^9>^yG?Wm7iCx;Kd=$jhI>;u+Usz>ie^Mq9nODdwPeRTUq)H4|3rJWjw9NMDTTn@quqTz{ z2WPuInM|TWN|llE4$fSKxS?=a0>htO0W(EdY7K_|Pxr!4T6X_E*7IO(tC1G(1_AU2 zB~n`Fpk!3J;9(YTG6w2RCTHhM9iY|i>jWYbs5h|K+`kjtX8ne$s%tbbzA-L(H zOwH9Hddhr1AfQwZ%~z^I(-s&1x2k_M?-YUaqITJwJbkyt4l@S+E5j6x4+b%Yr`?@1 zKQ6-p0nHp+A89Cl3h)n47D|E!^6YA0w1`|)i!Gz^e{Lv!D>#n$%cMM0!cQ`VFe_eU z4!e1n1$N~hLj6VFvNWC(pof=N;gP2L>Cm*absk!xxa7DLLC*4-a)3>ie|`Dfzwer$ zDS=l&Z_%qK@)!4*rkGC91J^o22&82?WWSF|ociPeT5G0aAPT>9$lM}4E|d+R2g_3l zEx&B~9}(11l{cVAg+$Kl1MyFv4il8ZFNuI$Jg4FPlStNYW?})2Yj#SVk;E)H)`x`P zOhXCIluDsYib&QTeR~7NaYDC^*k{IoJr+saAw2G2O;AZix$R%9?w4+*9|`y;N^X&xAmtclF_T{_@Slv8Y z2PyeuJIoULX9x$0gDY5F@K~%ovD;~nV&Wk70_fdhH>5rB7m@byql8pPg}}P;rogvE znGkolH$f{8Sl-KJl9&+3PVI6&i|}}tLgkT5d;j~-fnq*^^TPRzulH83`gjbiK1m85 zANv?40`wMH;^)tVr`6nHpzV5NwVY)AWgGpTE)n&?3-KRpYlzWK3(^Ztylj z(0bpEE6y53jU-a|b57OEAaYXem^AqL0eCI2fD|cjCgE}EXhFz+zFI>6 zHdvmb-IhqA#PMChqj$A_{?NC#M2*~AbZ?;Y3alO^`w>B8Cr`qzyKE-dtn}5=AJO=~ z=)NE5AMWcNos-&QXzZ6=#pyJ314(bZ>NI~_iR1KR(DAd%Z585L8`}0zsGChPfH5lS zx@%MDIZ<;JD7ZYKuOp%CH_X}F=PBk^BZ8DAv2{dlvMCe9bdjTgjy9BDnN&77?mcLx z3bVKRCHVa3q+0I)$ui+qNTNZ-G7=1ZiXiXqLyBjKia=azZyq)!a6DZ|s*TbAK@BF#NqOfiy6|iHaq{T5O2efBZWo%m&nn9s6ay&Qk>Q z^(3&7J5F`FyRBrI`^CkM$~>JZ)hSjU%|lB2cfI=%9LlFjo^wQM6F8-8zzdSZ?;uc_wIuqZJ@x)&;0HQd`-+C=h-Y=|=&ttk8oJ%~tj{LzW;=dA zaiv%)WapTy+Li+y^Dhto-_3bag9NP4FtPs`@sRoyL)co&m4a!CP}#;O0arPzK?ovl zQ%)4#Pr`orat&)0zB+h;Ikuc5A7wUhmWdcNie=?@(wK|bk(eFL|{Qj z9)H4}tC!X*;py7>T(iM@yC4vJvrEpqX#|a``WT@^36PwhbIkbWwvR ziLOAUfUuNQSfMxB=6R1TTcZytW4%>IQz2|}!R9h1p7otvoDDh~*9yKE^@|VXb=1DT z4!!UFUp9J)V548=5{a^5Q)ec>Pc0Ria@S*Fyr+^2p_9hZ$9C@`f-aQ)dLm^MhvR(= za@eInZ<8w1^5=^&zafF(U;GFHzS%N&o9Jx%j&_22 Date: Thu, 6 May 2021 13:30:16 -0500 Subject: [PATCH 07/20] [packages] Add @kbn/dev-utils as a dependency of @kbn/crypto (#99500) --- packages/kbn-crypto/BUILD.bazel | 1 + 1 file changed, 1 insertion(+) diff --git a/packages/kbn-crypto/BUILD.bazel b/packages/kbn-crypto/BUILD.bazel index 3e23f17acaea0..8f55f0e0f06a7 100644 --- a/packages/kbn-crypto/BUILD.bazel +++ b/packages/kbn-crypto/BUILD.bazel @@ -27,6 +27,7 @@ NPM_MODULE_EXTRA_FILES = [ ] SRC_DEPS = [ + "//packages/kbn-dev-utils", "@npm//jest-styled-components", "@npm//node-forge", ] From 64b9136f468d8a665d4b914eb16afdfd525a47ea Mon Sep 17 00:00:00 2001 From: Dario Gieselaar Date: Thu, 6 May 2021 20:42:04 +0200 Subject: [PATCH 08/20] [APM] fix typo in ML callout (#99412) --- .../components/app/Settings/anomaly_detection/create_jobs.ts | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/x-pack/plugins/apm/public/components/app/Settings/anomaly_detection/create_jobs.ts b/x-pack/plugins/apm/public/components/app/Settings/anomaly_detection/create_jobs.ts index c7c435331f640..a5ab0a3002bb6 100644 --- a/x-pack/plugins/apm/public/components/app/Settings/anomaly_detection/create_jobs.ts +++ b/x-pack/plugins/apm/public/components/app/Settings/anomaly_detection/create_jobs.ts @@ -63,7 +63,7 @@ function getSuccessToastMessage(environments: string[]) { function getErrorToastMessage(environments: string[], error: Error) { return i18n.translate('xpack.apm.anomalyDetection.createJobs.failed.text', { defaultMessage: - 'Something went wrong when creating one ore more anomaly detection jobs for APM service environments [{environments}]. Error: "{errorMessage}"', + 'Something went wrong when creating one or more anomaly detection jobs for APM service environments [{environments}]. Error: "{errorMessage}"', values: { environments: environments.join(', '), errorMessage: error.message, From 9ab755a8ba8a7629c84a5d0db5269c57806c6cc7 Mon Sep 17 00:00:00 2001 From: Pierre Gayvallet Date: Thu, 6 May 2021 20:45:20 +0200 Subject: [PATCH 09/20] Ensure deterministic plugin import order (#99451) * Ensure deterministic plugin import * remove exclusive test * shorter sort --- .../discovery/plugins_discovery.test.mocks.ts | 6 + .../discovery/plugins_discovery.test.ts | 57 +++- .../plugins/discovery/plugins_discovery.ts | 120 +-------- .../scan_plugin_search_paths.test.ts | 249 ++++++++++++++++++ .../discovery/scan_plugin_search_paths.ts | 115 ++++++++ src/core/server/plugins/plugins_service.ts | 4 +- 6 files changed, 441 insertions(+), 110 deletions(-) create mode 100644 src/core/server/plugins/discovery/scan_plugin_search_paths.test.ts create mode 100644 src/core/server/plugins/discovery/scan_plugin_search_paths.ts diff --git a/src/core/server/plugins/discovery/plugins_discovery.test.mocks.ts b/src/core/server/plugins/discovery/plugins_discovery.test.mocks.ts index a986fd833f990..e1812dd213e10 100644 --- a/src/core/server/plugins/discovery/plugins_discovery.test.mocks.ts +++ b/src/core/server/plugins/discovery/plugins_discovery.test.mocks.ts @@ -13,3 +13,9 @@ export const mockPackage = { jest.doMock('load-json-file', () => ({ sync: () => mockPackage.raw, })); + +const { scanPluginSearchPaths } = jest.requireActual('./scan_plugin_search_paths'); +export const scanPluginSearchPathsMock = jest.fn().mockImplementation(scanPluginSearchPaths); +jest.doMock('./scan_plugin_search_paths', () => ({ + scanPluginSearchPaths: scanPluginSearchPathsMock, +})); diff --git a/src/core/server/plugins/discovery/plugins_discovery.test.ts b/src/core/server/plugins/discovery/plugins_discovery.test.ts index c129983702fef..f6028fa8b099d 100644 --- a/src/core/server/plugins/discovery/plugins_discovery.test.ts +++ b/src/core/server/plugins/discovery/plugins_discovery.test.ts @@ -8,11 +8,12 @@ // must be before mocks imports to avoid conflicting with `REPO_ROOT` accessor. import { REPO_ROOT } from '@kbn/dev-utils'; -import { mockPackage } from './plugins_discovery.test.mocks'; +import { mockPackage, scanPluginSearchPathsMock } from './plugins_discovery.test.mocks'; import mockFs from 'mock-fs'; import { loggingSystemMock } from '../../logging/logging_system.mock'; import { getEnvOptions, rawConfigServiceMock } from '../../config/mocks'; +import { from } from 'rxjs'; import { first, map, toArray } from 'rxjs/operators'; import { resolve } from 'path'; import { ConfigService, Env } from '../../config'; @@ -420,4 +421,58 @@ describe('plugins discovery system', () => { expect(loggingSystemMock.collect(logger).warn).toEqual([]); }); + + describe('discovery order', () => { + beforeEach(() => { + scanPluginSearchPathsMock.mockClear(); + }); + + it('returns the plugins in a deterministic order', async () => { + mockFs( + { + [`${KIBANA_ROOT}/src/plugins/plugin_a`]: Plugins.valid('pluginA'), + [`${KIBANA_ROOT}/plugins/plugin_b`]: Plugins.valid('pluginB'), + [`${KIBANA_ROOT}/x-pack/plugins/plugin_c`]: Plugins.valid('pluginC'), + }, + { createCwd: false } + ); + + scanPluginSearchPathsMock.mockReturnValue( + from([ + `${KIBANA_ROOT}/src/plugins/plugin_a`, + `${KIBANA_ROOT}/plugins/plugin_b`, + `${KIBANA_ROOT}/x-pack/plugins/plugin_c`, + ]) + ); + + let { plugin$ } = discover(new PluginsConfig(pluginConfig, env), coreContext, instanceInfo); + + expect(scanPluginSearchPathsMock).toHaveBeenCalledTimes(1); + let plugins = await plugin$.pipe(toArray()).toPromise(); + let pluginNames = plugins.map((plugin) => plugin.name); + + expect(pluginNames).toHaveLength(3); + // order coming from `ROOT/plugin` -> `ROOT/src/plugins` -> // ROOT/x-pack + expect(pluginNames).toEqual(['pluginB', 'pluginA', 'pluginC']); + + // second pass + scanPluginSearchPathsMock.mockReturnValue( + from([ + `${KIBANA_ROOT}/plugins/plugin_b`, + `${KIBANA_ROOT}/x-pack/plugins/plugin_c`, + `${KIBANA_ROOT}/src/plugins/plugin_a`, + ]) + ); + + plugin$ = discover(new PluginsConfig(pluginConfig, env), coreContext, instanceInfo).plugin$; + + expect(scanPluginSearchPathsMock).toHaveBeenCalledTimes(2); + plugins = await plugin$.pipe(toArray()).toPromise(); + pluginNames = plugins.map((plugin) => plugin.name); + + expect(pluginNames).toHaveLength(3); + // order coming from `ROOT/plugin` -> `ROOT/src/plugins` -> // ROOT/x-pack + expect(pluginNames).toEqual(['pluginB', 'pluginA', 'pluginC']); + }); + }); }); diff --git a/src/core/server/plugins/discovery/plugins_discovery.ts b/src/core/server/plugins/discovery/plugins_discovery.ts index 368795968a7cb..4df87265a00cf 100644 --- a/src/core/server/plugins/discovery/plugins_discovery.ts +++ b/src/core/server/plugins/discovery/plugins_discovery.ts @@ -6,10 +6,8 @@ * Side Public License, v 1. */ -import { readdir, stat } from 'fs'; -import { resolve } from 'path'; -import { bindNodeCallback, from, merge, Observable } from 'rxjs'; -import { catchError, filter, map, mergeMap, shareReplay } from 'rxjs/operators'; +import { from, merge } from 'rxjs'; +import { catchError, filter, map, mergeMap, concatMap, shareReplay, toArray } from 'rxjs/operators'; import { CoreContext } from '../../core_context'; import { Logger } from '../../logging'; import { PluginWrapper } from '../plugin'; @@ -17,16 +15,7 @@ import { createPluginInitializerContext, InstanceInfo } from '../plugin_context' import { PluginsConfig } from '../plugins_config'; import { PluginDiscoveryError } from './plugin_discovery_error'; import { parseManifest } from './plugin_manifest_parser'; - -const fsReadDir$ = bindNodeCallback(readdir); -const fsStat$ = bindNodeCallback(stat); - -const maxScanDepth = 5; - -interface PluginSearchPathEntry { - dir: string; - depth: number; -} +import { scanPluginSearchPaths } from './scan_plugin_search_paths'; /** * Tries to discover all possible plugins based on the provided plugin config. @@ -54,9 +43,17 @@ export function discover( const discoveryResults$ = merge( from(config.additionalPluginPaths), - processPluginSearchPaths$(config.pluginSearchPaths, log) + scanPluginSearchPaths(config.pluginSearchPaths, log) ).pipe( - mergeMap((pluginPathOrError) => { + toArray(), + mergeMap((pathAndErrors) => { + return pathAndErrors.sort((a, b) => { + const pa = typeof a === 'string' ? a : a.path; + const pb = typeof b === 'string' ? b : b.path; + return pa < pb ? -1 : pa > pb ? 1 : 0; + }); + }), + concatMap((pluginPathOrError) => { return typeof pluginPathOrError === 'string' ? createPlugin$(pluginPathOrError, log, coreContext, instanceInfo) : [pluginPathOrError]; @@ -74,97 +71,6 @@ export function discover( }; } -/** - * Recursively iterates over every plugin search path and returns a merged stream of all - * sub-directories containing a manifest file. If directory cannot be read or it's impossible to get stat - * for any of the nested entries then error is added into the stream instead. - * - * @param pluginDirs List of the top-level directories to process. - * @param log Plugin discovery logger instance. - */ -function processPluginSearchPaths$( - pluginDirs: readonly string[], - log: Logger -): Observable { - function recursiveScanFolder( - ent: PluginSearchPathEntry - ): Observable { - return from([ent]).pipe( - mergeMap((entry) => { - return findManifestInFolder(entry.dir, () => { - if (entry.depth > maxScanDepth) { - return []; - } - return mapSubdirectories(entry.dir, (subDir) => - recursiveScanFolder({ dir: subDir, depth: entry.depth + 1 }) - ); - }); - }) - ); - } - - return from(pluginDirs.map((dir) => ({ dir, depth: 0 }))).pipe( - mergeMap((entry) => { - log.debug(`Scanning "${entry.dir}" for plugin sub-directories...`); - return fsReadDir$(entry.dir).pipe( - mergeMap(() => recursiveScanFolder(entry)), - catchError((err) => [PluginDiscoveryError.invalidSearchPath(entry.dir, err)]) - ); - }) - ); -} - -/** - * Attempts to read manifest file in specified directory or calls `notFound` and returns results if not found. For any - * manifest files that cannot be read, a PluginDiscoveryError is added. - * @param dir - * @param notFound - */ -function findManifestInFolder( - dir: string, - notFound: () => never[] | Observable -): string[] | Observable { - return fsStat$(resolve(dir, 'kibana.json')).pipe( - mergeMap((stats) => { - // `kibana.json` exists in given directory, we got a plugin - if (stats.isFile()) { - return [dir]; - } - return []; - }), - catchError((manifestStatError) => { - // did not find manifest. recursively process sub directories until we reach max depth. - if (manifestStatError.code !== 'ENOENT') { - return [PluginDiscoveryError.invalidPluginPath(dir, manifestStatError)]; - } - return notFound(); - }) - ); -} - -/** - * Finds all subdirectories in `dir` and executed `mapFunc` for each one. For any directories that cannot be read, - * a PluginDiscoveryError is added. - * @param dir - * @param mapFunc - */ -function mapSubdirectories( - dir: string, - mapFunc: (subDir: string) => Observable -): Observable { - return fsReadDir$(dir).pipe( - mergeMap((subDirs: string[]) => subDirs.map((subDir) => resolve(dir, subDir))), - mergeMap((subDir) => - fsStat$(subDir).pipe( - mergeMap((pathStat) => (pathStat.isDirectory() ? mapFunc(subDir) : [])), - catchError((subDirStatError) => [ - PluginDiscoveryError.invalidPluginPath(subDir, subDirStatError), - ]) - ) - ) - ); -} - /** * Tries to load and parse the plugin manifest file located at the provided plugin * directory path and produces an error result if it fails to do so or plugin manifest diff --git a/src/core/server/plugins/discovery/scan_plugin_search_paths.test.ts b/src/core/server/plugins/discovery/scan_plugin_search_paths.test.ts new file mode 100644 index 0000000000000..8c5e1f256aaa0 --- /dev/null +++ b/src/core/server/plugins/discovery/scan_plugin_search_paths.test.ts @@ -0,0 +1,249 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0 and the Server Side Public License, v 1; you may not use this file except + * in compliance with, at your election, the Elastic License 2.0 or the Server + * Side Public License, v 1. + */ + +import mockFs from 'mock-fs'; +import { loggingSystemMock } from '../../logging/logging_system.mock'; +import { toArray } from 'rxjs/operators'; +import { resolve } from 'path'; +import { scanPluginSearchPaths } from './scan_plugin_search_paths'; +import { PluginDiscoveryError } from './plugin_discovery_error'; + +const KIBANA_ROOT = process.cwd(); + +const Plugins = { + missingManifest: () => ({}), + inaccessibleManifest: () => ({ + 'kibana.json': mockFs.file({ + mode: 0, // 0000, + content: JSON.stringify({ id: 'plugin', version: '1' }), + }), + }), + valid: (id: string) => ({ + 'kibana.json': JSON.stringify({ + id, + configPath: ['plugins', id], + version: '1', + kibanaVersion: '1.2.3', + requiredPlugins: [], + optionalPlugins: [], + server: true, + }), + }), +}; + +const scanPaths = [ + `${KIBANA_ROOT}/src/plugins`, + `${KIBANA_ROOT}/plugins`, + `${KIBANA_ROOT}/x-pack/plugins`, +]; + +describe('scanPluginSearchPaths', () => { + let logger: ReturnType; + + beforeEach(async () => { + logger = loggingSystemMock.createLogger(); + + // jest relies on the filesystem to get sourcemaps when using console.log + // which breaks with the mocked FS, see https://github.com/tschaub/mock-fs/issues/234 + // hijacking logging to process.stdout as a workaround for this suite. + jest.spyOn(console, 'log').mockImplementation((...args) => { + process.stdout.write(args + '\n'); + }); + }); + + afterEach(() => { + mockFs.restore(); + // restore the console.log behavior + jest.restoreAllMocks(); + }); + + const extract = ( + pathOrErrors: Array + ): { paths: string[]; errors: PluginDiscoveryError[] } => { + return { + paths: pathOrErrors.filter((e) => typeof e === 'string') as string[], + errors: pathOrErrors.filter((e) => typeof e !== 'string') as PluginDiscoveryError[], + }; + }; + + it('discovers plugins in the search locations', async () => { + mockFs( + { + [`${KIBANA_ROOT}/src/plugins/plugin_a`]: Plugins.valid('pluginA'), + [`${KIBANA_ROOT}/plugins/plugin_b`]: Plugins.valid('pluginB'), + [`${KIBANA_ROOT}/x-pack/plugins/plugin_c`]: Plugins.valid('pluginC'), + }, + { createCwd: false } + ); + + const pluginOrErrors$ = scanPluginSearchPaths(scanPaths, logger); + const { paths, errors } = extract(await pluginOrErrors$.pipe(toArray()).toPromise()); + + expect(paths).toHaveLength(3); + expect(errors).toHaveLength(0); + + expect(paths).toEqual( + expect.arrayContaining([ + `${KIBANA_ROOT}/src/plugins/plugin_a`, + `${KIBANA_ROOT}/plugins/plugin_b`, + `${KIBANA_ROOT}/x-pack/plugins/plugin_c`, + ]) + ); + }); + + it('ignores folder if the manifest is missing', async () => { + mockFs( + { + [`${KIBANA_ROOT}/src/plugins/plugin_a`]: Plugins.valid('pluginA'), + [`${KIBANA_ROOT}/src/plugins/plugin_b`]: Plugins.missingManifest(), + }, + { createCwd: false } + ); + + const pluginOrErrors$ = scanPluginSearchPaths([`${KIBANA_ROOT}/src/plugins`], logger); + const { paths, errors } = extract(await pluginOrErrors$.pipe(toArray()).toPromise()); + + expect(paths).toHaveLength(1); + expect(errors).toHaveLength(0); + + expect(paths).toEqual([`${KIBANA_ROOT}/src/plugins/plugin_a`]); + }); + + it('return errors when the plugin search path is not accessible', async () => { + mockFs( + { + [`${KIBANA_ROOT}/src/plugins`]: mockFs.directory({ + mode: 0, // 0000 + items: { + plugin_a: Plugins.valid('pluginA'), + }, + }), + }, + { createCwd: false } + ); + + const pluginOrErrors$ = scanPluginSearchPaths([`${KIBANA_ROOT}/src/plugins`], logger); + const { paths, errors } = extract(await pluginOrErrors$.pipe(toArray()).toPromise()); + + expect(paths).toHaveLength(0); + expect(errors).toHaveLength(1); + + const srcPluginsPath = resolve(KIBANA_ROOT, 'src', 'plugins'); + expect(errors.map((e) => e.toString())).toEqual( + expect.arrayContaining([ + `Error: EACCES, permission denied '${srcPluginsPath}' (invalid-search-path, ${srcPluginsPath})`, + ]) + ); + }); + + it('discovers plugins in nested directories', async () => { + mockFs( + { + [`${KIBANA_ROOT}/src/plugins/plugin_a`]: Plugins.valid('pluginA'), + [`${KIBANA_ROOT}/src/plugins/sub1/plugin_b`]: Plugins.valid('pluginB'), + [`${KIBANA_ROOT}/src/plugins/sub1/sub2/plugin_c`]: Plugins.valid('pluginC'), + [`${KIBANA_ROOT}/src/plugins/sub1/sub2/plugin_d`]: Plugins.valid('pluginD'), + }, + { createCwd: false } + ); + + const pluginOrErrors$ = scanPluginSearchPaths([`${KIBANA_ROOT}/src/plugins`], logger); + const { paths, errors } = extract(await pluginOrErrors$.pipe(toArray()).toPromise()); + + expect(errors).toHaveLength(0); + expect(paths).toHaveLength(4); + + expect(paths).toEqual( + expect.objectContaining([ + `${KIBANA_ROOT}/src/plugins/plugin_a`, + `${KIBANA_ROOT}/src/plugins/sub1/plugin_b`, + `${KIBANA_ROOT}/src/plugins/sub1/sub2/plugin_c`, + `${KIBANA_ROOT}/src/plugins/sub1/sub2/plugin_d`, + ]) + ); + }); + + it('does not discover plugins nested inside another plugin', async () => { + mockFs( + { + [`${KIBANA_ROOT}/src/plugins/plugin_a`]: { + ...Plugins.valid('pluginA'), + nested_plugin: Plugins.valid('nestedPlugin'), + }, + }, + { createCwd: false } + ); + + const pluginOrErrors$ = scanPluginSearchPaths([`${KIBANA_ROOT}/src/plugins`], logger); + const { paths, errors } = extract(await pluginOrErrors$.pipe(toArray()).toPromise()); + + expect(errors).toHaveLength(0); + expect(paths).toHaveLength(1); + + expect(paths).toEqual([`${KIBANA_ROOT}/src/plugins/plugin_a`]); + }); + + it('stops scanning when reaching `maxDepth`', async () => { + mockFs( + { + [`${KIBANA_ROOT}/src/plugins/sub1/plugin`]: Plugins.valid('plugin1'), + [`${KIBANA_ROOT}/src/plugins/sub1/sub2/plugin`]: Plugins.valid('plugin2'), + [`${KIBANA_ROOT}/src/plugins/sub1/sub2/sub3/plugin`]: Plugins.valid('plugin3'), + [`${KIBANA_ROOT}/src/plugins/sub1/sub2/sub3/sub4/plugin`]: Plugins.valid('plugin4'), + [`${KIBANA_ROOT}/src/plugins/sub1/sub2/sub3/sub4/sub5/plugin`]: Plugins.valid('plugin5'), + [`${KIBANA_ROOT}/src/plugins/sub1/sub2/sub3/sub4/sub5/sub6/plugin`]: Plugins.valid( + 'plugin6' + ), + }, + { createCwd: false } + ); + + const pluginOrErrors$ = scanPluginSearchPaths([`${KIBANA_ROOT}/src/plugins`], logger); + const { paths, errors } = extract(await pluginOrErrors$.pipe(toArray()).toPromise()); + + expect(errors).toHaveLength(0); + expect(paths).toHaveLength(5); + + expect(paths).toEqual( + expect.arrayContaining([ + `${KIBANA_ROOT}/src/plugins/sub1/plugin`, + `${KIBANA_ROOT}/src/plugins/sub1/sub2/plugin`, + `${KIBANA_ROOT}/src/plugins/sub1/sub2/sub3/plugin`, + `${KIBANA_ROOT}/src/plugins/sub1/sub2/sub3/sub4/plugin`, + `${KIBANA_ROOT}/src/plugins/sub1/sub2/sub3/sub4/sub5/plugin`, + ]) + ); + }); + + it('works with symlinks', async () => { + const pluginFolder = resolve(KIBANA_ROOT, '..', 'ext-plugins'); + + mockFs( + { + [`${KIBANA_ROOT}/plugins`]: mockFs.symlink({ + path: '../ext-plugins', + }), + [pluginFolder]: { + plugin_a: Plugins.valid('pluginA'), + plugin_b: Plugins.valid('pluginB'), + }, + }, + { createCwd: false } + ); + + const pluginOrErrors$ = scanPluginSearchPaths([`${KIBANA_ROOT}/plugins`], logger); + const { paths, errors } = extract(await pluginOrErrors$.pipe(toArray()).toPromise()); + + expect(errors).toHaveLength(0); + expect(paths).toHaveLength(2); + + expect(paths).toEqual( + expect.arrayContaining([`${KIBANA_ROOT}/plugins/plugin_a`, `${KIBANA_ROOT}/plugins/plugin_b`]) + ); + }); +}); diff --git a/src/core/server/plugins/discovery/scan_plugin_search_paths.ts b/src/core/server/plugins/discovery/scan_plugin_search_paths.ts new file mode 100644 index 0000000000000..ffe73ff9b53e8 --- /dev/null +++ b/src/core/server/plugins/discovery/scan_plugin_search_paths.ts @@ -0,0 +1,115 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0 and the Server Side Public License, v 1; you may not use this file except + * in compliance with, at your election, the Elastic License 2.0 or the Server + * Side Public License, v 1. + */ + +import { readdir, stat } from 'fs'; +import { resolve } from 'path'; +import { bindNodeCallback, from, Observable } from 'rxjs'; +import { catchError, mergeMap } from 'rxjs/operators'; +import { Logger } from '../../logging'; +import { PluginDiscoveryError } from './plugin_discovery_error'; + +const fsReadDir$ = bindNodeCallback(readdir); +const fsStat$ = bindNodeCallback(stat); + +const maxScanDepth = 5; + +interface PluginSearchPathEntry { + dir: string; + depth: number; +} + +/** + * Recursively iterates over every plugin search path and returns a merged stream of all + * sub-directories containing a manifest file. If directory cannot be read or it's impossible to get stat + * for any of the nested entries then error is added into the stream instead. + * + * @param pluginDirs List of the top-level directories to process. + * @param log Plugin discovery logger instance. + */ +export function scanPluginSearchPaths( + pluginDirs: readonly string[], + log: Logger +): Observable { + function recursiveScanFolder( + ent: PluginSearchPathEntry + ): Observable { + return from([ent]).pipe( + mergeMap((entry) => { + return findManifestInFolder(entry.dir, () => { + if (entry.depth > maxScanDepth) { + return []; + } + return mapSubdirectories(entry.dir, (subDir) => + recursiveScanFolder({ dir: subDir, depth: entry.depth + 1 }) + ); + }); + }) + ); + } + + return from(pluginDirs.map((dir) => ({ dir, depth: 0 }))).pipe( + mergeMap((entry) => { + log.debug(`Scanning "${entry.dir}" for plugin sub-directories...`); + return fsReadDir$(entry.dir).pipe( + mergeMap(() => recursiveScanFolder(entry)), + catchError((err) => [PluginDiscoveryError.invalidSearchPath(entry.dir, err)]) + ); + }) + ); +} + +/** + * Attempts to read manifest file in specified directory or calls `notFound` and returns results if not found. For any + * manifest files that cannot be read, a PluginDiscoveryError is added. + * @param dir + * @param notFound + */ +function findManifestInFolder( + dir: string, + notFound: () => never[] | Observable +): string[] | Observable { + return fsStat$(resolve(dir, 'kibana.json')).pipe( + mergeMap((stats) => { + // `kibana.json` exists in given directory, we got a plugin + if (stats.isFile()) { + return [dir]; + } + return []; + }), + catchError((manifestStatError) => { + // did not find manifest. recursively process sub directories until we reach max depth. + if (manifestStatError.code !== 'ENOENT') { + return [PluginDiscoveryError.invalidPluginPath(dir, manifestStatError)]; + } + return notFound(); + }) + ); +} + +/** + * Finds all subdirectories in `dir` and executed `mapFunc` for each one. For any directories that cannot be read, + * a PluginDiscoveryError is added. + * @param dir + * @param mapFunc + */ +function mapSubdirectories( + dir: string, + mapFunc: (subDir: string) => Observable +): Observable { + return fsReadDir$(dir).pipe( + mergeMap((subDirs: string[]) => subDirs.map((subDir) => resolve(dir, subDir))), + mergeMap((subDir) => + fsStat$(subDir).pipe( + mergeMap((pathStat) => (pathStat.isDirectory() ? mapFunc(subDir) : [])), + catchError((subDirStatError) => [ + PluginDiscoveryError.invalidPluginPath(subDir, subDirStatError), + ]) + ) + ) + ); +} diff --git a/src/core/server/plugins/plugins_service.ts b/src/core/server/plugins/plugins_service.ts index 547fe00fdb1cf..99a9aaaddcb0b 100644 --- a/src/core/server/plugins/plugins_service.ts +++ b/src/core/server/plugins/plugins_service.ts @@ -8,7 +8,7 @@ import Path from 'path'; import { Observable } from 'rxjs'; -import { filter, first, map, mergeMap, tap, toArray } from 'rxjs/operators'; +import { filter, first, map, concatMap, tap, toArray } from 'rxjs/operators'; import { pick, getFlattenedObject } from '@kbn/std'; import { CoreService } from '../../types'; @@ -206,7 +206,7 @@ export class PluginsService implements CoreService(); await plugin$ .pipe( - mergeMap(async (plugin) => { + concatMap(async (plugin) => { const configDescriptor = plugin.getConfigDescriptor(); if (configDescriptor) { this.pluginConfigDescriptors.set(plugin.name, configDescriptor); From e4e574082b431de6ac2e6d9f1863eb86241de093 Mon Sep 17 00:00:00 2001 From: Jonathan Budzenski Date: Thu, 6 May 2021 13:56:29 -0500 Subject: [PATCH 10/20] [packages] Move @kbn/ace to Bazel (#99129) --- .../monorepo-packages.asciidoc | 1 + package.json | 2 +- packages/BUILD.bazel | 1 + packages/kbn-ace/BUILD.bazel | 85 +++++++++++++++++++ packages/kbn-ace/package.json | 8 +- packages/kbn-ace/scripts/build.js | 54 ------------ ...son.ace.worker.js => x_json.ace.worker.ts} | 2 + packages/kbn-ace/tsconfig.json | 11 +-- yarn.lock | 2 +- 9 files changed, 97 insertions(+), 69 deletions(-) create mode 100644 packages/kbn-ace/BUILD.bazel delete mode 100644 packages/kbn-ace/scripts/build.js rename packages/kbn-ace/src/ace/modes/x_json/worker/{x_json.ace.worker.js => x_json.ace.worker.ts} (99%) diff --git a/docs/developer/getting-started/monorepo-packages.asciidoc b/docs/developer/getting-started/monorepo-packages.asciidoc index f4f226ec8728f..cba5b9bfadf98 100644 --- a/docs/developer/getting-started/monorepo-packages.asciidoc +++ b/docs/developer/getting-started/monorepo-packages.asciidoc @@ -64,6 +64,7 @@ yarn kbn watch-bazel - @elastic/datemath - @elastic/eslint-config-kibana - @elastic/safer-lodash-set +- @kbn/ace - @kbn/analytics - @kbn/apm-config-loader - @kbn/apm-utils diff --git a/package.json b/package.json index dc0521e03deaa..781d6cda7dd09 100644 --- a/package.json +++ b/package.json @@ -122,7 +122,7 @@ "@hapi/inert": "^6.0.3", "@hapi/podium": "^4.1.1", "@hapi/wreck": "^17.1.0", - "@kbn/ace": "link:packages/kbn-ace", + "@kbn/ace": "link:bazel-bin/packages/kbn-ace/npm_module", "@kbn/analytics": "link:bazel-bin/packages/kbn-analytics/npm_module", "@kbn/apm-config-loader": "link:bazel-bin/packages/kbn-apm-config-loader/npm_module", "@kbn/apm-utils": "link:bazel-bin/packages/kbn-apm-utils/npm_module", diff --git a/packages/BUILD.bazel b/packages/BUILD.bazel index 10600e514cfb6..8b483f54344e2 100644 --- a/packages/BUILD.bazel +++ b/packages/BUILD.bazel @@ -6,6 +6,7 @@ filegroup( "//packages/elastic-datemath:build", "//packages/elastic-eslint-config-kibana:build", "//packages/elastic-safer-lodash-set:build", + "//packages/kbn-ace:build", "//packages/kbn-analytics:build", "//packages/kbn-apm-config-loader:build", "//packages/kbn-apm-utils:build", diff --git a/packages/kbn-ace/BUILD.bazel b/packages/kbn-ace/BUILD.bazel new file mode 100644 index 0000000000000..f52754d864777 --- /dev/null +++ b/packages/kbn-ace/BUILD.bazel @@ -0,0 +1,85 @@ +load("@npm//@bazel/typescript:index.bzl", "ts_config", "ts_project") +load("@build_bazel_rules_nodejs//:index.bzl", "js_library", "pkg_npm") + +PKG_BASE_NAME = "kbn-ace" +PKG_REQUIRE_NAME = "@kbn/ace" + +SOURCE_FILES = glob( + [ + "src/**/*.ts", + ], + exclude = [ + "src/ace/modes/x_json/worker/worker.d.ts", + "**/*.test.*", + ], +) + +SRCS = SOURCE_FILES + +filegroup( + name = "srcs", + srcs = SRCS, +) + +NPM_MODULE_EXTRA_FILES = [ + "package.json", + "README.md" +] + +SRC_DEPS = [ + "@npm//brace", + "@npm//lodash", + "@npm//raw-loader", +] + +TYPES_DEPS = [ + "@npm//@types/lodash", + "@npm//@types/node", +] + +DEPS = SRC_DEPS + TYPES_DEPS + +ts_config( + name = "tsconfig", + src = "tsconfig.json", + deps = [ + "//:tsconfig.base.json", + ], +) + +ts_project( + name = "tsc", + args = ['--pretty'], + srcs = SRCS, + deps = DEPS, + declaration = True, + declaration_map = True, + incremental = True, + out_dir = "target", + source_map = True, + root_dir = "src", + tsconfig = ":tsconfig", +) + +js_library( + name = PKG_BASE_NAME, + srcs = NPM_MODULE_EXTRA_FILES, + deps = [":tsc"] + DEPS, + package_name = PKG_REQUIRE_NAME, + visibility = ["//visibility:public"], +) + +pkg_npm( + name = "npm_module", + deps = [ + ":%s" % PKG_BASE_NAME, + ] +) + +filegroup( + name = "build", + srcs = [ + ":npm_module", + ], + visibility = ["//visibility:public"], +) \ No newline at end of file diff --git a/packages/kbn-ace/package.json b/packages/kbn-ace/package.json index 30a87dbd1e21b..8dd175b787148 100644 --- a/packages/kbn-ace/package.json +++ b/packages/kbn-ace/package.json @@ -4,9 +4,5 @@ "private": true, "main": "./target/index.js", "types": "./target/index.d.ts", - "license": "SSPL-1.0 OR Elastic License 2.0", - "scripts": { - "build": "node ./scripts/build.js", - "kbn:bootstrap": "yarn build --dev" - } -} \ No newline at end of file + "license": "SSPL-1.0 OR Elastic License 2.0" +} diff --git a/packages/kbn-ace/scripts/build.js b/packages/kbn-ace/scripts/build.js deleted file mode 100644 index c6248ae29f60f..0000000000000 --- a/packages/kbn-ace/scripts/build.js +++ /dev/null @@ -1,54 +0,0 @@ -/* - * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one - * or more contributor license agreements. Licensed under the Elastic License - * 2.0 and the Server Side Public License, v 1; you may not use this file except - * in compliance with, at your election, the Elastic License 2.0 or the Server - * Side Public License, v 1. - */ - -const path = require('path'); -const del = require('del'); -const fs = require('fs'); -const supportsColor = require('supports-color'); -const { run } = require('@kbn/dev-utils'); - -const TARGET_BUILD_DIR = path.resolve(__dirname, '../target'); -const ROOT_DIR = path.resolve(__dirname, '../'); -const WORKER_PATH_SECTION = 'ace/modes/x_json/worker/x_json.ace.worker.js'; - -run( - async ({ procRunner, log }) => { - log.info('Deleting old output'); - - await del(TARGET_BUILD_DIR); - - const cwd = ROOT_DIR; - const env = { ...process.env }; - - if (supportsColor.stdout) { - env.FORCE_COLOR = 'true'; - } - - await procRunner.run('tsc ', { - cmd: 'tsc', - args: [], - wait: true, - env, - cwd, - }); - - log.success('Copying worker file to target.'); - - fs.copyFileSync( - path.resolve(__dirname, '..', 'src', WORKER_PATH_SECTION), - path.resolve(__dirname, '..', 'target', WORKER_PATH_SECTION) - ); - - log.success('Complete'); - }, - { - flags: { - boolean: ['dev'], - }, - } -); diff --git a/packages/kbn-ace/src/ace/modes/x_json/worker/x_json.ace.worker.js b/packages/kbn-ace/src/ace/modes/x_json/worker/x_json.ace.worker.ts similarity index 99% rename from packages/kbn-ace/src/ace/modes/x_json/worker/x_json.ace.worker.js rename to packages/kbn-ace/src/ace/modes/x_json/worker/x_json.ace.worker.ts index 37b0113774134..751f93808f892 100644 --- a/packages/kbn-ace/src/ace/modes/x_json/worker/x_json.ace.worker.js +++ b/packages/kbn-ace/src/ace/modes/x_json/worker/x_json.ace.worker.ts @@ -48,6 +48,8 @@ It is very likely that this file will be removed in future but for now it enables extended JSON parsing, like e.g. """{}""" (triple quotes) */ +// @internal +// @ts-nocheck "no use strict"; ! function(window) { function resolveModuleId(id, paths) { diff --git a/packages/kbn-ace/tsconfig.json b/packages/kbn-ace/tsconfig.json index 9eef1ec56c6a2..d5abe0f7bb9fc 100644 --- a/packages/kbn-ace/tsconfig.json +++ b/packages/kbn-ace/tsconfig.json @@ -1,17 +1,14 @@ { "extends": "../../tsconfig.base.json", "compilerOptions": { - "incremental": false, + "incremental": true, "outDir": "./target", "declaration": true, "declarationMap": true, "sourceMap": true, "sourceRoot": "../../../../packages/kbn-ace/src", - "types": [ - "node" - ], + "stripInternal": true, + "types": ["node"] }, - "include": [ - "src/**/*" - ] + "include": ["src/**/*"] } diff --git a/yarn.lock b/yarn.lock index 699f10936dc75..bc951e0ecb59e 100644 --- a/yarn.lock +++ b/yarn.lock @@ -2583,7 +2583,7 @@ "@babel/runtime" "^7.7.2" regenerator-runtime "^0.13.3" -"@kbn/ace@link:packages/kbn-ace": +"@kbn/ace@link:bazel-bin/packages/kbn-ace/npm_module": version "0.0.0" uid "" From d993ec791110b93d4eaace69cc252abb4c0292f7 Mon Sep 17 00:00:00 2001 From: Gloria Hornero Date: Thu, 6 May 2021 21:02:12 +0200 Subject: [PATCH 11/20] [Security Solution] [Detections] Adds investigate in timeline test for indicator match generated alerts (#99214) * adds investigate in timeline test for indicator match generated alerts * refactor * removes duplicated line * refactor Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com> --- .../indicator_match_rule.spec.ts | 40 +++++++++++++++++-- .../security_solution/cypress/objects/rule.ts | 6 +-- .../cypress/objects/timeline.ts | 7 ++++ .../cypress/screens/timeline.ts | 4 ++ .../cypress/tasks/api_calls/rules.ts | 2 + .../cypress/tasks/api_calls/timelines.ts | 7 ++++ 6 files changed, 59 insertions(+), 7 deletions(-) diff --git a/x-pack/plugins/security_solution/cypress/integration/detection_rules/indicator_match_rule.spec.ts b/x-pack/plugins/security_solution/cypress/integration/detection_rules/indicator_match_rule.spec.ts index 2a36a3d707aa8..2ced1689e5946 100644 --- a/x-pack/plugins/security_solution/cypress/integration/detection_rules/indicator_match_rule.spec.ts +++ b/x-pack/plugins/security_solution/cypress/integration/detection_rules/indicator_match_rule.spec.ts @@ -54,10 +54,12 @@ import { TIMELINE_FIELD, TIMELINE_TEMPLATE_DETAILS, } from '../../screens/rule_details'; +import { INDICATOR_MATCH_ROW_RENDER, PROVIDER_BADGE } from '../../screens/timeline'; import { expandFirstAlert, goToManageAlertsDetectionRules, + investigateFirstAlertInTimeline, waitForAlertsIndexToBeCreated, waitForAlertsPanelToBeLoaded, } from '../../tasks/alerts'; @@ -75,6 +77,7 @@ import { checkDuplicatedRule, } from '../../tasks/alerts_detection_rules'; import { createCustomIndicatorRule } from '../../tasks/api_calls/rules'; +import { loadPrepackagedTimelineTemplates } from '../../tasks/api_calls/timelines'; import { cleanKibana, reload } from '../../tasks/common'; import { createAndActivateRule, @@ -392,15 +395,15 @@ describe('indicator match', () => { beforeEach(() => { cleanKibana(); loginAndWaitForPageWithoutDateRange(DETECTIONS_URL); + }); + + it('Creates and activates a new Indicator Match rule', () => { waitForAlertsPanelToBeLoaded(); waitForAlertsIndexToBeCreated(); goToManageAlertsDetectionRules(); waitForRulesTableToBeLoaded(); goToCreateNewRule(); selectIndicatorMatchType(); - }); - - it('Creates and activates a new Indicator Match rule', () => { fillDefineIndicatorMatchRuleAndContinue(newThreatIndicatorRule); fillAboutRuleAndContinue(newThreatIndicatorRule); fillScheduleRuleAndContinue(newThreatIndicatorRule); @@ -446,7 +449,7 @@ describe('indicator match', () => { cy.get(DEFINITION_DETAILS).within(() => { getDetails(INDEX_PATTERNS_DETAILS).should( 'have.text', - newThreatIndicatorRule.index!.join('') + newThreatIndicatorRule.index.join('') ); getDetails(CUSTOM_QUERY_DETAILS).should('have.text', '*:*'); getDetails(RULE_TYPE_DETAILS).should('have.text', 'Indicator Match'); @@ -485,6 +488,35 @@ describe('indicator match', () => { .should('have.text', newThreatIndicatorRule.severity.toLowerCase()); cy.get(ALERT_RULE_RISK_SCORE).first().should('have.text', newThreatIndicatorRule.riskScore); }); + + it('Investigate alert in timeline', () => { + const accessibilityText = `Press enter for options, or press space to begin dragging.`; + const threatIndicatorPath = + '../../../x-pack/test/security_solution_cypress/es_archives/threat_indicator/data.json'; + + loadPrepackagedTimelineTemplates(); + + goToManageAlertsDetectionRules(); + createCustomIndicatorRule(newThreatIndicatorRule); + + reload(); + goToRuleDetails(); + waitForAlertsToPopulate(); + investigateFirstAlertInTimeline(); + + cy.get(PROVIDER_BADGE).should('have.length', 3); + cy.get(PROVIDER_BADGE).should( + 'have.text', + `threat.indicator.matched.atomic: "${newThreatIndicatorRule.atomic}"threat.indicator.matched.type: "${newThreatIndicatorRule.type}"threat.indicator.matched.field: "${newThreatIndicatorRule.indicatorMappingField}"` + ); + + cy.readFile(threatIndicatorPath).then((threatIndicator) => { + cy.get(INDICATOR_MATCH_ROW_RENDER).should( + 'have.text', + `threat.indicator.matched.field${newThreatIndicatorRule.indicatorMappingField}${accessibilityText}matched${newThreatIndicatorRule.indicatorMappingField}${newThreatIndicatorRule.atomic}${accessibilityText}threat.indicator.matched.type${newThreatIndicatorRule.type}${accessibilityText}fromthreat.indicator.event.dataset${threatIndicator.value.source.event.dataset}${accessibilityText}:threat.indicator.event.reference${threatIndicator.value.source.event.reference}(opens in a new tab or window)${accessibilityText}` + ); + }); + }); }); describe('Enrichment', () => { diff --git a/x-pack/plugins/security_solution/cypress/objects/rule.ts b/x-pack/plugins/security_solution/cypress/objects/rule.ts index 12523e39cb597..9a8626f2a0d7d 100644 --- a/x-pack/plugins/security_solution/cypress/objects/rule.ts +++ b/x-pack/plugins/security_solution/cypress/objects/rule.ts @@ -8,7 +8,7 @@ /* eslint-disable @kbn/eslint/no-restricted-paths */ import { rawRules } from '../../server/lib/detection_engine/rules/prepackaged_rules/index'; import { mockThreatData } from '../../public/detections/mitre/mitre_tactics_techniques'; -import { CompleteTimeline, timeline } from './timeline'; +import { timeline, CompleteTimeline, indicatorMatchTimelineTemplate } from './timeline'; export const totalNumberOfPrebuiltRules = rawRules.length; @@ -41,7 +41,7 @@ export interface CustomRule { customQuery?: string; name: string; description: string; - index?: string[]; + index: string[]; interval?: string; severity: string; riskScore: string; @@ -334,7 +334,7 @@ export const newThreatIndicatorRule: ThreatIndicatorRule = { indicatorIndexField: 'threatintel.indicator.file.hash.sha256', type: 'file', atomic: 'a04ac6d98ad989312783d4fe3456c53730b212c79a426fb215708b6c6daa3de3', - timeline, + timeline: indicatorMatchTimelineTemplate, maxSignals: 100, }; diff --git a/x-pack/plugins/security_solution/cypress/objects/timeline.ts b/x-pack/plugins/security_solution/cypress/objects/timeline.ts index b5089c9775666..1b66b50605508 100644 --- a/x-pack/plugins/security_solution/cypress/objects/timeline.ts +++ b/x-pack/plugins/security_solution/cypress/objects/timeline.ts @@ -15,6 +15,7 @@ export interface Timeline { export interface CompleteTimeline extends Timeline { notes: string; filter: TimelineFilter; + templateTimelineId?: string; } export interface TimelineFilter { @@ -37,6 +38,12 @@ export const timeline: CompleteTimeline = { filter, }; +export const indicatorMatchTimelineTemplate: CompleteTimeline = { + ...timeline, + title: 'Generic Threat Match Timeline', + templateTimelineId: '495ad7a7-316e-4544-8a0f-9c098daee76e', +}; + /** * Timeline query that finds no valid data to cut down on test failures * or other issues for when we want to test one specific thing and not also diff --git a/x-pack/plugins/security_solution/cypress/screens/timeline.ts b/x-pack/plugins/security_solution/cypress/screens/timeline.ts index 4c80f266e687c..88e207fcea339 100644 --- a/x-pack/plugins/security_solution/cypress/screens/timeline.ts +++ b/x-pack/plugins/security_solution/cypress/screens/timeline.ts @@ -26,6 +26,8 @@ export const CASE = (id: string) => { export const CLOSE_TIMELINE_BTN = '[data-test-subj="close-timeline"]'; +export const COLUMN_HEADERS = '[data-test-subj="column-headers"] [data-test-subj^=header-text]'; + export const COMBO_BOX = '.euiComboBoxOption__content'; export const CREATE_NEW_TIMELINE = '[data-test-subj="timeline-new"]'; @@ -94,6 +96,8 @@ export const SAVE_FILTER_BTN = '[data-test-subj="saveFilter"]'; export const SEARCH_OR_FILTER_CONTAINER = '[data-test-subj="timeline-search-or-filter-search-container"]'; +export const INDICATOR_MATCH_ROW_RENDER = '[data-test-subj="threat-match-row"]'; + export const QUERY_TAB_EVENTS_TABLE = '[data-test-subj="query-events-table"]'; export const QUERY_TAB_EVENTS_BODY = '[data-test-subj="query-tab-flyout-body"]'; diff --git a/x-pack/plugins/security_solution/cypress/tasks/api_calls/rules.ts b/x-pack/plugins/security_solution/cypress/tasks/api_calls/rules.ts index 617a06cc8e79a..b4e4941ff7f94 100644 --- a/x-pack/plugins/security_solution/cypress/tasks/api_calls/rules.ts +++ b/x-pack/plugins/security_solution/cypress/tasks/api_calls/rules.ts @@ -41,6 +41,8 @@ export const createCustomIndicatorRule = (rule: ThreatIndicatorRule, ruleId = 'r name: rule.name, severity: rule.severity.toLocaleLowerCase(), type: 'threat_match', + timeline_id: rule.timeline.templateTimelineId, + timeline_title: rule.timeline.title, threat_mapping: [ { entries: [ diff --git a/x-pack/plugins/security_solution/cypress/tasks/api_calls/timelines.ts b/x-pack/plugins/security_solution/cypress/tasks/api_calls/timelines.ts index 453c2db8afd65..18359574633e9 100644 --- a/x-pack/plugins/security_solution/cypress/tasks/api_calls/timelines.ts +++ b/x-pack/plugins/security_solution/cypress/tasks/api_calls/timelines.ts @@ -112,3 +112,10 @@ export const getTimelineById = (timelineId: string) => url: `api/timeline?id=${timelineId}`, headers: { 'kbn-xsrf': 'timeline-by-id' }, }); + +export const loadPrepackagedTimelineTemplates = () => + cy.request({ + method: 'POST', + url: 'api/timeline/_prepackaged', + headers: { 'kbn-xsrf': 'cypress-creds' }, + }); From 43aead77cbb8450e71bb1bfea1b512d881547ec6 Mon Sep 17 00:00:00 2001 From: John Dorlus Date: Thu, 6 May 2021 15:24:16 -0400 Subject: [PATCH 12/20] Add Component Integration Test For Common Processor Fields (#97194) * Added test for setting common fields. All except the if field as it uses monaco text editor. Reaching out for help with this issue. * Added assertion for the code editor. * Added await to fix promise rejection. * Added mockCodeEditor data test subject to correct file. * Removed unneeded comment. * Split out common processors test and fixed nits in PR feedback. Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com> --- .../__jest__/processors/bytes.test.tsx | 11 --- .../common_processor_fields.test.tsx | 77 +++++++++++++++++++ .../__jest__/processors/processor.helpers.tsx | 4 + .../common_fields/common_processor_fields.tsx | 10 ++- 4 files changed, 89 insertions(+), 13 deletions(-) create mode 100644 x-pack/plugins/ingest_pipelines/public/application/components/pipeline_editor/__jest__/processors/common_processor_fields.test.tsx diff --git a/x-pack/plugins/ingest_pipelines/public/application/components/pipeline_editor/__jest__/processors/bytes.test.tsx b/x-pack/plugins/ingest_pipelines/public/application/components/pipeline_editor/__jest__/processors/bytes.test.tsx index c6449dbd7a93e..af4f6e468ca36 100644 --- a/x-pack/plugins/ingest_pipelines/public/application/components/pipeline_editor/__jest__/processors/bytes.test.tsx +++ b/x-pack/plugins/ingest_pipelines/public/application/components/pipeline_editor/__jest__/processors/bytes.test.tsx @@ -8,12 +8,6 @@ import { act } from 'react-dom/test-utils'; import { setup, SetupResult, getProcessorValue } from './processor.helpers'; -// Default parameter values automatically added to the Bytes processor when saved -const defaultBytesParameters = { - ignore_failure: undefined, - description: undefined, -}; - const BYTES_TYPE = 'bytes'; describe('Processor: Bytes', () => { @@ -85,7 +79,6 @@ describe('Processor: Bytes', () => { const processors = getProcessorValue(onUpdate, BYTES_TYPE); expect(processors[0].bytes).toEqual({ field: 'field_1', - ...defaultBytesParameters, }); }); @@ -112,13 +105,9 @@ describe('Processor: Bytes', () => { const processors = getProcessorValue(onUpdate, BYTES_TYPE); expect(processors[0].bytes).toEqual({ - description: undefined, field: 'field_1', - ignore_failure: undefined, target_field: 'target_field', ignore_missing: true, - tag: undefined, - if: undefined, }); }); }); diff --git a/x-pack/plugins/ingest_pipelines/public/application/components/pipeline_editor/__jest__/processors/common_processor_fields.test.tsx b/x-pack/plugins/ingest_pipelines/public/application/components/pipeline_editor/__jest__/processors/common_processor_fields.test.tsx new file mode 100644 index 0000000000000..af4c187df75e6 --- /dev/null +++ b/x-pack/plugins/ingest_pipelines/public/application/components/pipeline_editor/__jest__/processors/common_processor_fields.test.tsx @@ -0,0 +1,77 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0; you may not use this file except in compliance with the Elastic License + * 2.0. + */ + +import { act } from 'react-dom/test-utils'; +import { setup, SetupResult, getProcessorValue } from './processor.helpers'; + +const BYTES_TYPE = 'bytes'; + +describe('Processor: Common Fields For All Processors', () => { + let onUpdate: jest.Mock; + let testBed: SetupResult; + + beforeAll(() => { + jest.useFakeTimers(); + }); + + afterAll(() => { + jest.useRealTimers(); + }); + + beforeEach(async () => { + onUpdate = jest.fn(); + + await act(async () => { + testBed = await setup({ + value: { + processors: [], + }, + onFlyoutOpen: jest.fn(), + onUpdate, + }); + }); + testBed.component.update(); + }); + + test('saves with common fields set', async () => { + const { + actions: { addProcessor, saveNewProcessor, addProcessorType }, + form, + find, + } = testBed; + + // This test ensures that the common fields that are used across all processors + // works and removes the need for those fields to be in every processors' test. + + // Open flyout to add new processor + addProcessor(); + // Add type (the other fields are not visible until a type is selected) + await addProcessorType(BYTES_TYPE); + // Add "field" value (required) + form.setInputValue('fieldNameField.input', 'field_1'); + + form.toggleEuiSwitch('ignoreFailureSwitch.input'); + + form.setInputValue('tagField.input', 'some_tag'); + + // Edit the Code Editor + const jsonContent = JSON.stringify({ content: "ctx?.network?.name == 'Guest'" }); + await find('mockCodeEditor').simulate('change', { jsonContent }); + + // Save the field + await saveNewProcessor(); + + const processors = getProcessorValue(onUpdate, BYTES_TYPE); + expect(processors[0].bytes).toEqual({ + field: 'field_1', + ignore_failure: true, + if: jsonContent, + tag: 'some_tag', + ignore_missing: undefined, + }); + }); +}); diff --git a/x-pack/plugins/ingest_pipelines/public/application/components/pipeline_editor/__jest__/processors/processor.helpers.tsx b/x-pack/plugins/ingest_pipelines/public/application/components/pipeline_editor/__jest__/processors/processor.helpers.tsx index 8340cf45b1f1b..8616241a43d8d 100644 --- a/x-pack/plugins/ingest_pipelines/public/application/components/pipeline_editor/__jest__/processors/processor.helpers.tsx +++ b/x-pack/plugins/ingest_pipelines/public/application/components/pipeline_editor/__jest__/processors/processor.helpers.tsx @@ -139,7 +139,11 @@ type TestSubject = | 'addProcessorForm.submitButton' | 'processorTypeSelector.input' | 'fieldNameField.input' + | 'mockCodeEditor' + | 'tagField.input' | 'ignoreMissingSwitch.input' + | 'ignoreFailureSwitch.input' + | 'ifField.textarea' | 'targetField.input' | 'keepOriginalField.input' | 'removeIfSuccessfulField.input'; diff --git a/x-pack/plugins/ingest_pipelines/public/application/components/pipeline_editor/components/processor_form/processors/common_fields/common_processor_fields.tsx b/x-pack/plugins/ingest_pipelines/public/application/components/pipeline_editor/components/processor_form/processors/common_fields/common_processor_fields.tsx index f6449c3cc24d4..20cfd28781f53 100644 --- a/x-pack/plugins/ingest_pipelines/public/application/components/pipeline_editor/components/processor_form/processors/common_fields/common_processor_fields.tsx +++ b/x-pack/plugins/ingest_pipelines/public/application/components/pipeline_editor/components/processor_form/processors/common_fields/common_processor_fields.tsx @@ -65,6 +65,7 @@ export const CommonProcessorFields: FunctionComponent = () => { return (

{ path="fields.if" /> - + - +
); }; From 7ed6e36156ef1d06ea5d2de80fd5f325fa0dc71c Mon Sep 17 00:00:00 2001 From: Melissa Alvarez Date: Thu, 6 May 2021 15:27:14 -0400 Subject: [PATCH 13/20] [ML] Anomaly Detection explorer: ensure map reflects anomalies selected (#99403) * show choropleth layer for anomalies present * use type guard --- .../application/explorer/anomalies_map.tsx | 46 +++++++++---------- 1 file changed, 23 insertions(+), 23 deletions(-) diff --git a/x-pack/plugins/ml/public/application/explorer/anomalies_map.tsx b/x-pack/plugins/ml/public/application/explorer/anomalies_map.tsx index fcdd0a71a8f55..7914061dc81c7 100644 --- a/x-pack/plugins/ml/public/application/explorer/anomalies_map.tsx +++ b/x-pack/plugins/ml/public/application/explorer/anomalies_map.tsx @@ -24,6 +24,7 @@ import { COLOR_MAP_TYPE, } from '../../../../maps/common/constants'; import { useMlKibana } from '../contexts/kibana'; +import { isDefined } from '../../../common/types/guards'; import { MlEmbeddedMapComponent } from '../components/ml_embedded_map'; import { EMSTermJoinConfig } from '../../../../maps/public'; import { AnomaliesTableRecord } from '../../../common/types/anomalies'; @@ -65,8 +66,7 @@ function getAnomalyRows(anomalies: AnomaliesTableRecord[], jobId: string) { export const getChoroplethAnomaliesLayer = ( anomalies: AnomaliesTableRecord[], - { layerId, field, jobId }: MLEMSTermJoinConfig, - visible: boolean + { layerId, field, jobId }: MLEMSTermJoinConfig ): VectorLayerDescriptor => { return { id: htmlIdGenerator()(), @@ -132,7 +132,7 @@ export const getChoroplethAnomaliesLayer = ( }, isTimeAware: true, }, - visible, + visible: false, type: 'VECTOR', }; }; @@ -147,9 +147,7 @@ interface MLEMSTermJoinConfig extends EMSTermJoinConfig { } export const AnomaliesMap: FC = ({ anomalies, jobIds }) => { - const [EMSSuggestions, setEMSSuggestions] = useState< - Array | undefined - >(); + const [EMSSuggestions, setEMSSuggestions] = useState(); const { services: { maps: mapsPlugin }, } = useMlKibana(); @@ -195,7 +193,7 @@ export const AnomaliesMap: FC = ({ anomalies, jobIds }) => { }) ); - setEMSSuggestions(suggestions.filter((s) => s !== null)); + setEMSSuggestions(suggestions.filter(isDefined)); }, [...jobIds]); useEffect( @@ -207,24 +205,26 @@ export const AnomaliesMap: FC = ({ anomalies, jobIds }) => { [...jobIds] ); - const layerList = useMemo(() => { - let layers: VectorLayerDescriptor[] = []; - // Loop through suggestions list and make a layer for each - if (EMSSuggestions?.length) { - let count = 0; - layers = EMSSuggestions.reduce(function (result, suggestion) { - if (suggestion) { - const visible = count === 0; - result.push(getChoroplethAnomaliesLayer(anomalies, suggestion, visible)); - count++; - } - return result; - }, [] as VectorLayerDescriptor[]); - } - return layers; + const layerList: VectorLayerDescriptor[] = useMemo(() => { + if (!EMSSuggestions?.length) return []; + + return EMSSuggestions.map((suggestion) => { + return getChoroplethAnomaliesLayer(anomalies, suggestion); + }, [] as VectorLayerDescriptor[]); }, [EMSSuggestions, anomalies]); - if (EMSSuggestions?.length === 0) { + const layersWithAnomalies = layerList.filter((layer) => { + // @ts-ignore _rows does not exist - can remove when VectorLayerDescriptor is updated + const rows = Array.isArray(layer.joins) ? layer.joins[0]?.right?.__rows : []; + return rows.length; + }); + + // set the layer with anomalies to visible + if (layersWithAnomalies.length > 0) { + layersWithAnomalies[0].visible = true; + } + + if (EMSSuggestions?.length === 0 || layersWithAnomalies.length === 0) { return null; } From d5ebbac4f7010dfee87d0cba16847a501ff05b92 Mon Sep 17 00:00:00 2001 From: Stacey Gammon Date: Thu, 6 May 2021 15:29:47 -0400 Subject: [PATCH 14/20] Add support for building a deprecation list with usage (#99154) * Add support for building a deprecation list with usage * Update API docs --- api_docs/actions.json | 1216 +- api_docs/advanced_settings.json | 202 +- api_docs/alerting.json | 2112 +- api_docs/apm.json | 402 +- api_docs/apm_oss.json | 479 +- api_docs/banners.json | 86 +- api_docs/beats_management.json | 22 +- api_docs/bfetch.json | 741 +- api_docs/canvas.json | 68 +- api_docs/cases.json | 3792 +-- api_docs/charts.json | 1749 +- api_docs/cloud.json | 198 +- api_docs/console.json | 24 +- api_docs/core.json | 18061 ++++++++----- api_docs/core_application.json | 1549 +- api_docs/core_chrome.json | 1602 +- api_docs/core_http.json | 4156 +-- api_docs/core_saved_objects.json | 8767 +++--- api_docs/dashboard.json | 1604 +- api_docs/dashboard_enhanced.json | 668 +- api_docs/dashboard_mode.json | 126 +- api_docs/data.json | 19088 +++++++------ api_docs/data_autocomplete.json | 234 +- api_docs/data_enhanced.json | 165 +- api_docs/data_field_formats.json | 2822 +- api_docs/data_index_patterns.json | 4606 ++-- api_docs/data_query.json | 1758 +- api_docs/data_search.json | 15295 ++++++----- api_docs/data_ui.json | 369 +- api_docs/deprecations.mdx | 2424 ++ api_docs/dev_tools.json | 109 +- api_docs/discover.json | 685 +- api_docs/discover_enhanced.json | 502 +- api_docs/embeddable.json | 5574 ++-- api_docs/embeddable_enhanced.json | 183 +- api_docs/encrypted_saved_objects.json | 216 +- api_docs/enterprise_search.json | 22 +- api_docs/es_ui_shared.json | 1146 +- api_docs/event_log.json | 791 +- api_docs/expressions.json | 22278 +++++++++------- api_docs/features.json | 2176 +- api_docs/file_data_visualizer.json | 166 +- api_docs/file_upload.json | 1213 +- api_docs/fleet.json | 10998 +++++--- api_docs/global_search.json | 711 +- api_docs/home.json | 842 +- api_docs/index_lifecycle_management.json | 52 +- api_docs/index_management.json | 1632 +- api_docs/index_pattern_field_editor.json | 351 +- api_docs/index_pattern_management.json | 488 +- api_docs/infra.json | 169 +- api_docs/ingest_pipelines.json | 118 +- api_docs/inspector.json | 1148 +- api_docs/kibana_legacy.json | 1234 +- api_docs/kibana_react.json | 2957 +- api_docs/kibana_utils.json | 6047 +++-- api_docs/lens.json | 1798 +- api_docs/license_api_guard.json | 91 +- api_docs/license_management.json | 28 +- api_docs/licensing.json | 2104 +- api_docs/lists.json | 5872 ++-- api_docs/management.json | 410 +- api_docs/maps.json | 1879 +- api_docs/maps_ems.json | 757 +- api_docs/metrics_entities.json | 76 +- api_docs/ml.json | 2780 +- api_docs/ml.mdx | 3 - api_docs/monitoring.json | 100 +- api_docs/navigation.json | 321 +- api_docs/newsfeed.json | 148 +- api_docs/observability.json | 2088 +- api_docs/osquery.json | 84 +- api_docs/presentation_util.json | 1129 +- api_docs/remote_clusters.json | 36 +- api_docs/reporting.json | 1543 +- api_docs/rollup.json | 200 +- api_docs/rule_registry.json | 618 +- api_docs/runtime_fields.json | 282 +- api_docs/saved_objects.json | 2502 +- api_docs/saved_objects_management.json | 1036 +- api_docs/saved_objects_tagging.json | 560 +- api_docs/saved_objects_tagging_oss.json | 1007 +- api_docs/security.json | 951 +- api_docs/security_oss.json | 128 +- api_docs/security_solution.json | 13100 ++++++++- api_docs/share.json | 738 +- api_docs/snapshot_restore.json | 253 +- api_docs/spaces.json | 1641 +- api_docs/spaces_oss.json | 720 +- api_docs/stack_alerts.json | 42 +- api_docs/task_manager.json | 460 +- api_docs/telemetry.json | 410 +- api_docs/telemetry_collection_manager.json | 286 +- api_docs/telemetry_collection_xpack.json | 10 +- api_docs/telemetry_management_section.json | 145 +- api_docs/timelines.json | 58 +- api_docs/triggers_actions_ui.json | 2451 +- api_docs/ui_actions.json | 1676 +- api_docs/ui_actions_enhanced.json | 2356 +- api_docs/uptime.json | 76 +- api_docs/url_forwarding.json | 154 +- api_docs/usage_collection.json | 505 +- api_docs/vis_type_timeseries.json | 120 +- api_docs/visualizations.json | 2580 +- .../buid_api_declaration.test.ts | 45 +- .../build_api_declaration.ts | 74 +- .../build_arrow_fn_dec.ts | 38 +- .../build_basic_api_declaration.ts | 89 + .../build_api_declarations/build_class_dec.ts | 39 +- .../build_function_dec.ts | 28 +- .../build_function_type_dec.ts | 45 - .../build_interface_dec.ts | 38 +- .../build_parameter_decs.ts | 35 +- .../build_type_literal_dec.ts | 47 +- .../build_variable_dec.ts | 71 +- .../extract_import_refs.test.ts | 4 +- .../extract_import_refs.ts | 2 +- .../build_api_declarations/get_references.ts | 81 + .../build_api_declarations/js_doc_utils.ts | 22 +- .../src/api_docs/build_api_docs_cli.ts | 55 +- .../src/api_docs/get_plugin_api.ts | 39 +- .../src/api_docs/get_plugin_api_map.ts | 39 +- .../api_docs/mdx/split_apis_by_folder.test.ts | 2 +- .../api_docs/mdx/write_deprecations_doc.ts | 61 + .../src/api_docs/mdx/write_plugin_mdx_docs.ts | 2 +- .../mdx/write_plugin_split_by_folder.test.ts | 2 +- .../src/plugin_a/public/classes.ts | 5 + .../__fixtures__/src/plugin_b/kibana.json | 5 + .../__fixtures__/src/plugin_b/public/index.ts | 13 + .../src/api_docs/tests/api_doc_suite.test.ts | 22 +- .../api_docs/tests/snapshots/plugin_a.json | 1091 +- .../tests/snapshots/plugin_a_foo.json | 30 +- .../api_docs/tests/snapshots/plugin_b.json | 88 + .../src/api_docs/tests/snapshots/plugin_b.mdx | 18 + .../src/api_docs/tsmorph_utils.ts | 4 +- packages/kbn-docs-utils/src/api_docs/types.ts | 31 +- .../kbn-docs-utils/src/api_docs/utils.test.ts | 2 +- packages/kbn-docs-utils/src/api_docs/utils.ts | 1 - 138 files changed, 134769 insertions(+), 79904 deletions(-) create mode 100644 api_docs/deprecations.mdx create mode 100644 packages/kbn-docs-utils/src/api_docs/build_api_declarations/build_basic_api_declaration.ts delete mode 100644 packages/kbn-docs-utils/src/api_docs/build_api_declarations/build_function_type_dec.ts create mode 100644 packages/kbn-docs-utils/src/api_docs/build_api_declarations/get_references.ts create mode 100644 packages/kbn-docs-utils/src/api_docs/mdx/write_deprecations_doc.ts create mode 100644 packages/kbn-docs-utils/src/api_docs/tests/__fixtures__/src/plugin_b/kibana.json create mode 100644 packages/kbn-docs-utils/src/api_docs/tests/__fixtures__/src/plugin_b/public/index.ts create mode 100644 packages/kbn-docs-utils/src/api_docs/tests/snapshots/plugin_b.json create mode 100644 packages/kbn-docs-utils/src/api_docs/tests/snapshots/plugin_b.mdx diff --git a/api_docs/actions.json b/api_docs/actions.json index 7205080cf768e..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,105 +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 }, { - "tags": [], + "parentPluginId": "actions", "id": "def-server.ActionResult.isMissingSecrets", "type": "CompoundType", + "tags": [], "label": "isMissingSecrets", "description": [], + "signature": [ + "boolean | undefined" + ], "source": { "path": "x-pack/plugins/actions/server/types.ts", "lineNumber": 66 }, - "signature": [ - "boolean | undefined" - ] + "deprecated": false }, { - "tags": [], + "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 }, - "signature": [ - "Config | undefined" - ] + "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": 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": [ "() => ", { @@ -220,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": [ "() => ", { @@ -242,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", @@ -276,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", @@ -296,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", @@ -319,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": 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": 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": 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": 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": 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": 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": 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": 114 - } + }, + "deprecated": false, + "isRequired": false } ], - "tags": [], - "returnComment": [], - "source": { - "path": "x-pack/plugins/actions/server/types.ts", - "lineNumber": 111 - } + "returnComment": [] }, { - "tags": [], + "parentPluginId": "actions", "id": "def-server.ActionType.executor", "type": "Function", + "tags": [], "label": "executor", "description": [], + "signature": [ + "ExecutorType", + "" + ], "source": { "path": "x-pack/plugins/actions/server/types.ts", "lineNumber": 116 }, - "signature": [ - "ExecutorType", - "" - ] + "deprecated": false } ], - "source": { - "path": "x-pack/plugins/actions/server/types.ts", - "lineNumber": 96 - }, "initialIsOpen": false }, { + "parentPluginId": "actions", "id": "def-server.ActionTypeExecutorOptions", "type": "Interface", + "tags": [], "label": "ActionTypeExecutorOptions", + "description": [], "signature": [ { "pluginId": "actions", @@ -481,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", @@ -580,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": 75 }, - "signature": [ - "Secrets" - ] + "deprecated": false } ], - "source": { - "path": "x-pack/plugins/actions/server/types.ts", - "lineNumber": 71 - }, "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 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; }" - ], + "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<", { @@ -812,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: ", { @@ -1003,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", @@ -1020,163 +1175,185 @@ }, "" ], - "description": [], "source": { "path": "x-pack/plugins/actions/server/plugin.ts", - "lineNumber": 99 - } + "lineNumber": 94 + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "x-pack/plugins/actions/server/plugin.ts", - "lineNumber": 93 - } + "returnComment": [] } ], - "source": { - "path": "x-pack/plugins/actions/server/plugin.ts", - "lineNumber": 92 - }, "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": 104 - } + "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": 104 - } + "lineNumber": 99 + }, + "deprecated": false } - ], - "source": { - "path": "x-pack/plugins/actions/server/plugin.ts", - "lineNumber": 104 - } + ] } ], - "tags": [], - "returnComment": [], - "source": { - "path": "x-pack/plugins/actions/server/plugin.ts", - "lineNumber": 104 - } + "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": 106 - } + "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": 107 - } + "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": 108 - } + "lineNumber": 103 + }, + "deprecated": false } - ], - "source": { - "path": "x-pack/plugins/actions/server/plugin.ts", - "lineNumber": 108 - } + ] } ], - "tags": [], - "returnComment": [], - "source": { - "path": "x-pack/plugins/actions/server/plugin.ts", - "lineNumber": 105 - } + "returnComment": [] }, { + "parentPluginId": "actions", "id": "def-server.PluginStartContract.getActionsClientWithRequest", "type": "Function", + "tags": [], "label": "getActionsClientWithRequest", + "description": [], "signature": [ "(request: ", { @@ -1196,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", @@ -1213,24 +1396,23 @@ }, "" ], - "description": [], "source": { "path": "x-pack/plugins/actions/server/plugin.ts", - "lineNumber": 110 - } + "lineNumber": 105 + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "x-pack/plugins/actions/server/plugin.ts", - "lineNumber": 110 - } + "returnComment": [] }, { + "parentPluginId": "actions", "id": "def-server.PluginStartContract.getActionsAuthorizationWithRequest", "type": "Function", + "tags": [], "label": "getActionsAuthorizationWithRequest", + "description": [], "signature": [ "(request: ", { @@ -1250,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", @@ -1267,30 +1455,23 @@ }, "" ], - "description": [], "source": { "path": "x-pack/plugins/actions/server/plugin.ts", - "lineNumber": 111 - } + "lineNumber": 106 + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "x-pack/plugins/actions/server/plugin.ts", - "lineNumber": 111 - } + "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": 112 - }, "signature": [ { "pluginId": "actions", @@ -1300,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": 114 - } + "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": 115 - } + "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": 116 - } + "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": 117 - } + "lineNumber": 112 + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "x-pack/plugins/actions/server/plugin.ts", - "lineNumber": 113 - } + "returnComment": [] } ], - "source": { - "path": "x-pack/plugins/actions/server/plugin.ts", - "lineNumber": 103 - }, "lifecycle": "start", "initialIsOpen": true } @@ -1388,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", @@ -1622,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: ", { @@ -1824,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)[] ? ", { @@ -1855,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 9fb72c9f24abb..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,77 +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", - "isRequired": true, + "description": [], "signature": [ "ElasticsearchError" ], - "description": [], "source": { "path": "x-pack/plugins/alerting/server/lib/errors/es_error_parser.ts", "lineNumber": 37 - } + }, + "deprecated": false, + "isRequired": true } ], - "signature": [ - "(error: ", - "ElasticsearchError", - ") => string" - ], - "description": [], - "label": "getEsErrorMessage", - "source": { - "path": "x-pack/plugins/alerting/server/lib/errors/es_error_parser.ts", - "lineNumber": 37 - }, - "tags": [], "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", @@ -185,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", @@ -234,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": 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": 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": 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": 89 - }, "signature": [ { "pluginId": "alerting", @@ -295,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": 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": 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": 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": 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": 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": 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": 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": 97 }, - "signature": [ - "string | null" - ] + "deprecated": false } ], - "source": { - "path": "x-pack/plugins/alerting/server/types.ts", - "lineNumber": 79 - }, "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": [ "() => ", { @@ -438,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<", { @@ -476,46 +533,52 @@ "text": "AlertsHealth" }, ">" - ] + ], + "source": { + "path": "x-pack/plugins/alerting/server/types.ts", + "lineNumber": 48 + }, + "deprecated": false }, { - "tags": [], + "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 }, - "signature": [ - "() => Promise" - ] + "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", + "tags": [], "label": "setup", "description": [], - "source": { - "path": "x-pack/plugins/alerting/server/types.ts", - "lineNumber": 220 - }, "signature": [ { "pluginId": "alerting", @@ -524,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": 221 - }, "signature": [ { "pluginId": "alerting", @@ -544,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": 219 - }, "initialIsOpen": false }, { + "parentPluginId": "alerting", "id": "def-server.AlertServices", "type": "Interface", + "tags": [], "label": "AlertServices", + "description": [], "signature": [ { "pluginId": "alerting", @@ -568,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": 74 - }, "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": 69 - }, "initialIsOpen": false }, { + "parentPluginId": "alerting", "id": "def-server.AlertType", "type": "Interface", + "tags": [], "label": "AlertType", + "description": [], "signature": [ { "pluginId": "alerting", @@ -608,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": 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": 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": 123 - }, "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": 126 - }, "signature": [ { "pluginId": "alerting", @@ -668,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": 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": 128 - }, "signature": [ { "pluginId": "alerting", @@ -703,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": 129 - }, "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": 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": 141 - }, "signature": [ "{ context?: ", { @@ -775,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": 146 }, - "signature": [ - "\"basic\" | \"standard\" | \"gold\" | \"platinum\" | \"enterprise\" | \"trial\"" - ] + "deprecated": false } ], - "source": { - "path": "x-pack/plugins/alerting/server/types.ts", - "lineNumber": 113 - }, "initialIsOpen": false }, { + "parentPluginId": "alerting", "id": "def-server.FindResult", "type": "Interface", + "tags": [], "label": "FindResult", + "description": [], "signature": [ { "pluginId": "alerting", @@ -812,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<", { @@ -868,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: ", { @@ -899,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", @@ -916,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: ", { @@ -983,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", @@ -1000,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<", { @@ -1034,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 }, - "signature": [ - "Pick, \"id\"> & Partial, \"enabled\" | \"name\" | \"params\" | \"actions\" | \"tags\" | \"muteAll\" | \"apiKey\" | \"alertTypeId\" | \"consumer\" | \"schedule\" | \"scheduledTaskId\" | \"createdBy\" | \"updatedBy\" | \"createdAt\" | \"updatedAt\" | \"apiKeyOwner\" | \"throttle\" | \"notifyWhen\" | \"mutedInstanceIds\" | \"executionStatus\">>" - ], + "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 } ], @@ -1215,9 +1353,12 @@ "classes": [], "functions": [ { + "parentPluginId": "alerting", "id": "def-common.getBuiltinActionGroups", "type": "Function", + "tags": [], "label": "getBuiltinActionGroups", + "description": [], "signature": [ "(customRecoveryGroup: ", { @@ -1245,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", @@ -1262,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", @@ -1499,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", @@ -1612,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", @@ -1702,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", @@ -1723,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", @@ -1908,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: ", { @@ -2061,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", @@ -2117,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", @@ -2151,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", @@ -2354,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: ", { @@ -2440,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: ", { @@ -2462,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: ", { @@ -2484,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", @@ -2518,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", @@ -2541,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", @@ -2585,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", @@ -2606,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", @@ -2708,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", @@ -2789,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", @@ -2908,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", "<[", @@ -3188,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: ", @@ -3211,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: ", @@ -3249,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<", { @@ -3272,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 cfe3b150db007..611bf6f455ec5 100644 --- a/api_docs/apm.json +++ b/api_docs/apm.json @@ -5,53 +5,61 @@ "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 } ], @@ -59,34 +67,38 @@ "misc": [], "objects": [], "setup": { + "parentPluginId": "apm", "id": "def-public.ApmPluginSetup", "type": "Type", - "label": "ApmPluginSetup", "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": 48 }, - "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\"; }; }>; }" - ], + "deprecated": false, "lifecycle": "setup", "initialIsOpen": true }, "start": { + "parentPluginId": "apm", "id": "def-public.ApmPluginStart", "type": "Type", - "label": "ApmPluginStart", "tags": [], + "label": "ApmPluginStart", "description": [], + "signature": [ + "void" + ], "source": { "path": "x-pack/plugins/apm/public/plugin.ts", "lineNumber": 51 }, - "signature": [ - "void" - ], + "deprecated": false, "lifecycle": "start", "initialIsOpen": true } @@ -94,6 +106,7 @@ "server": { "classes": [ { + "parentPluginId": "apm", "id": "def-server.APMPlugin", "type": "Class", "tags": [], @@ -128,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", @@ -153,24 +180,23 @@ }, "" ], - "description": [], "source": { "path": "x-pack/plugins/apm/server/plugin.ts", "lineNumber": 60 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "x-pack/plugins/apm/server/plugin.ts", - "lineNumber": 60 - } + "returnComment": [] }, { + "parentPluginId": "apm", "id": "def-server.APMPlugin.setup", "type": "Function", + "tags": [], "label": "setup", + "description": [], "signature": [ "(core: ", { @@ -189,13 +215,19 @@ "<{ '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", @@ -208,40 +240,42 @@ "APMPluginStartDependencies", ", unknown>" ], - "description": [], "source": { "path": "x-pack/plugins/apm/server/plugin.ts", "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\" | \"cloud\" | \"observability\" | \"apmOss\" | \"licensing\" | \"spaces\" | \"taskManager\" | \"alerting\">" ], - "description": [], "source": { "path": "x-pack/plugins/apm/server/plugin.ts", "lineNumber": 66 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "x-pack/plugins/apm/server/plugin.ts", - "lineNumber": 64 - } + "returnComment": [] }, { + "parentPluginId": "apm", "id": "def-server.APMPlugin.start", "type": "Function", + "tags": [], "label": "start", + "description": [], "signature": [ "(core: ", { @@ -253,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", @@ -269,49 +309,46 @@ "text": "CoreStart" } ], - "description": [], "source": { "path": "x-pack/plugins/apm/server/plugin.ts", "lineNumber": 200 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "x-pack/plugins/apm/server/plugin.ts", - "lineNumber": 200 - } + "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": 219 - } + }, + "deprecated": false, + "children": [], + "returnComment": [] } ], - "source": { - "path": "x-pack/plugins/apm/server/plugin.ts", - "lineNumber": 50 - }, "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", @@ -319,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": 46 - }, "signature": [ { "pluginId": "core", @@ -388,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": 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": 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": 53 - }, "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": 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": 55 - }, "signature": [ "{ setup: ", { @@ -476,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": 59 - }, "signature": [ "{ data: { setup: ", { @@ -529,71 +586,75 @@ "section": "def-server.RequestHandlerContext", "text": "RequestHandlerContext" } - ] + ], + "source": { + "path": "x-pack/plugins/apm/server/routes/typings.ts", + "lineNumber": 59 + }, + "deprecated": false }, { - "tags": [], + "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 }, - "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\"; }; }>" - ] + "deprecated": false } ], - "source": { - "path": "x-pack/plugins/apm/server/routes/typings.ts", - "lineNumber": 45 - }, "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": [], + "signature": [ + "{ response: any; duration: number; requestType: string; requestParams: Record; esError: Error; }[]" + ], "source": { "path": "x-pack/plugins/apm/server/routes/typings.ts", "lineNumber": 26 }, - "signature": [ - "{ response: any; duration: number; requestType: string; requestParams: Record; esError: Error; }[]" - ], + "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: ", { @@ -707,13 +784,14 @@ "InferSearchResponseOf", " ({ 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 d6aa1083806b6..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." ], + "signature": [ + "CanvasApi" + ], "source": { "path": "x-pack/plugins/canvas/public/plugin.tsx", "lineNumber": 68 }, - "signature": [ - "CanvasApi" - ], + "deprecated": false, "lifecycle": "setup", "initialIsOpen": true }, "start": { + "parentPluginId": "canvas", "id": "def-public.CanvasStart", "type": "Type", - "label": "CanvasStart", "tags": [], + "label": "CanvasStart", "description": [], + "signature": [ + "void" + ], "source": { "path": "x-pack/plugins/canvas/public/plugin.tsx", "lineNumber": 69 }, - "signature": [ - "void" - ], + "deprecated": false, "lifecycle": "start", "initialIsOpen": true } @@ -101,28 +107,32 @@ "misc": [], "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": [ { - "tags": [], + "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 } ], - "description": [], - "label": "UI_SETTINGS", - "source": { - "path": "x-pack/plugins/canvas/common/index.ts", - "lineNumber": 8 - }, "initialIsOpen": false } ] diff --git a/api_docs/cases.json b/api_docs/cases.json index 8794a288461db..190fbfe95fc6d 100644 --- a/api_docs/cases.json +++ b/api_docs/cases.json @@ -3,11 +3,10 @@ "client": { "classes": [ { + "parentPluginId": "cases", "id": "def-public.CasesUiPlugin", "type": "Class", - "tags": [ - "public" - ], + "tags": [], "label": "CasesUiPlugin", "description": [], "signature": [ @@ -51,21 +50,35 @@ "text": "StartPlugins" } ], + "source": { + "path": "x-pack/plugins/cases/public/plugin.ts", + "lineNumber": 26 + }, + "deprecated": false, "children": [ { + "parentPluginId": "cases", "id": "def-public.CasesUiPlugin.Unnamed", "type": "Function", + "tags": [], "label": "Constructor", + "description": [], "signature": [ "any" ], - "description": [], + "source": { + "path": "x-pack/plugins/cases/public/plugin.ts", + "lineNumber": 29 + }, + "deprecated": false, "children": [ { + "parentPluginId": "cases", "id": "def-public.CasesUiPlugin.Unnamed.$1", "type": "Object", + "tags": [], "label": "initializerContext", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "core", @@ -76,24 +89,23 @@ }, "" ], - "description": [], "source": { "path": "x-pack/plugins/cases/public/plugin.ts", "lineNumber": 29 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "x-pack/plugins/cases/public/plugin.ts", - "lineNumber": 29 - } + "returnComment": [] }, { + "parentPluginId": "cases", "id": "def-public.CasesUiPlugin.setup", "type": "Function", + "tags": [], "label": "setup", + "description": [], "signature": [ "(core: ", { @@ -113,13 +125,19 @@ }, ") => void" ], - "description": [], + "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", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "core", @@ -130,17 +148,20 @@ }, "" ], - "description": [], "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", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "cases", @@ -150,24 +171,23 @@ "text": "SetupPlugins" } ], - "description": [], "source": { "path": "x-pack/plugins/cases/public/plugin.ts", "lineNumber": 32 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "x-pack/plugins/cases/public/plugin.ts", - "lineNumber": 32 - } + "returnComment": [] }, { + "parentPluginId": "cases", "id": "def-public.CasesUiPlugin.start", "type": "Function", + "tags": [], "label": "start", + "description": [], "signature": [ "(core: ", { @@ -194,13 +214,19 @@ "text": "CasesUiStart" } ], - "description": [], + "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", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "core", @@ -210,17 +236,20 @@ "text": "CoreStart" } ], - "description": [], "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", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "cases", @@ -230,63 +259,60 @@ "text": "StartPlugins" } ], - "description": [], "source": { "path": "x-pack/plugins/cases/public/plugin.ts", "lineNumber": 38 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "x-pack/plugins/cases/public/plugin.ts", - "lineNumber": 38 - } + "returnComment": [] }, { + "parentPluginId": "cases", "id": "def-public.CasesUiPlugin.stop", "type": "Function", + "tags": [], "label": "stop", + "description": [], "signature": [ "() => void" ], - "description": [], - "children": [], - "tags": [], - "returnComment": [], "source": { "path": "x-pack/plugins/cases/public/plugin.ts", "lineNumber": 92 - } + }, + "deprecated": false, + "children": [], + "returnComment": [] } ], - "source": { - "path": "x-pack/plugins/cases/public/plugin.ts", - "lineNumber": 26 - }, "initialIsOpen": false } ], "functions": [], "interfaces": [ { + "parentPluginId": "cases", "id": "def-public.SetupPlugins", "type": "Interface", + "tags": [], "label": "SetupPlugins", "description": [], - "tags": [], + "source": { + "path": "x-pack/plugins/cases/public/types.ts", + "lineNumber": 22 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "cases", "id": "def-public.SetupPlugins.security", "type": "Object", + "tags": [], "label": "security", "description": [], - "source": { - "path": "x-pack/plugins/cases/public/types.ts", - "lineNumber": 23 - }, "signature": [ "{ authc: ", "AuthenticationServiceSetup", @@ -298,18 +324,20 @@ "Observable", "<", "SecurityLicenseFeatures" - ] + ], + "source": { + "path": "x-pack/plugins/cases/public/types.ts", + "lineNumber": 23 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "cases", "id": "def-public.SetupPlugins.triggersActionsUi", "type": "Object", + "tags": [], "label": "triggersActionsUi", "description": [], - "source": { - "path": "x-pack/plugins/cases/public/types.ts", - "lineNumber": 24 - }, "signature": [ { "pluginId": "triggersActionsUi", @@ -318,32 +346,36 @@ "section": "def-public.TriggersAndActionsUIPublicPluginSetup", "text": "TriggersAndActionsUIPublicPluginSetup" } - ] + ], + "source": { + "path": "x-pack/plugins/cases/public/types.ts", + "lineNumber": 24 + }, + "deprecated": false } ], - "source": { - "path": "x-pack/plugins/cases/public/types.ts", - "lineNumber": 22 - }, "initialIsOpen": false }, { + "parentPluginId": "cases", "id": "def-public.StartPlugins", "type": "Interface", + "tags": [], "label": "StartPlugins", "description": [], - "tags": [], + "source": { + "path": "x-pack/plugins/cases/public/types.ts", + "lineNumber": 27 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "cases", "id": "def-public.StartPlugins.triggersActionsUi", "type": "Object", + "tags": [], "label": "triggersActionsUi", "description": [], - "source": { - "path": "x-pack/plugins/cases/public/types.ts", - "lineNumber": 28 - }, "signature": [ { "pluginId": "triggersActionsUi", @@ -352,157 +384,174 @@ "section": "def-public.TriggersAndActionsUIPublicPluginStart", "text": "TriggersAndActionsUIPublicPluginStart" } - ] + ], + "source": { + "path": "x-pack/plugins/cases/public/types.ts", + "lineNumber": 28 + }, + "deprecated": false } ], - "source": { - "path": "x-pack/plugins/cases/public/types.ts", - "lineNumber": 27 - }, "initialIsOpen": false } ], "enums": [], "misc": [ { + "parentPluginId": "cases", "id": "def-public.StartServices", "type": "Type", - "label": "StartServices", "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 }, - "signature": [ - "CoreStart & StartPlugins & { security: SecurityPluginSetup; }" - ], + "deprecated": false, "initialIsOpen": false } ], "objects": [], "start": { + "parentPluginId": "cases", "id": "def-public.CasesUiStart", "type": "Interface", + "tags": [], "label": "CasesUiStart", "description": [], - "tags": [], + "source": { + "path": "x-pack/plugins/cases/public/types.ts", + "lineNumber": 42 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "cases", "id": "def-public.CasesUiStart.getAllCases", "type": "Function", + "tags": [], "label": "getAllCases", "description": [], - "source": { - "path": "x-pack/plugins/cases/public/types.ts", - "lineNumber": 43 - }, "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 }, { - "tags": [], + "parentPluginId": "cases", "id": "def-public.CasesUiStart.getAllCasesSelectorModal", "type": "Function", + "tags": [], "label": "getAllCasesSelectorModal", "description": [], - "source": { - "path": "x-pack/plugins/cases/public/types.ts", - "lineNumber": 44 - }, "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 }, { - "tags": [], + "parentPluginId": "cases", "id": "def-public.CasesUiStart.getCaseView", "type": "Function", + "tags": [], "label": "getCaseView", "description": [], - "source": { - "path": "x-pack/plugins/cases/public/types.ts", - "lineNumber": 47 - }, "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 }, { - "tags": [], + "parentPluginId": "cases", "id": "def-public.CasesUiStart.getConfigureCases", "type": "Function", + "tags": [], "label": "getConfigureCases", "description": [], - "source": { - "path": "x-pack/plugins/cases/public/types.ts", - "lineNumber": 48 - }, "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 }, { - "tags": [], + "parentPluginId": "cases", "id": "def-public.CasesUiStart.getCreateCase", "type": "Function", + "tags": [], "label": "getCreateCase", "description": [], - "source": { - "path": "x-pack/plugins/cases/public/types.ts", - "lineNumber": 49 - }, "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 }, { - "tags": [], + "parentPluginId": "cases", "id": "def-public.CasesUiStart.getRecentCases", "type": "Function", + "tags": [], "label": "getRecentCases", "description": [], - "source": { - "path": "x-pack/plugins/cases/public/types.ts", - "lineNumber": 50 - }, "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 } ], - "source": { - "path": "x-pack/plugins/cases/public/types.ts", - "lineNumber": 42 - }, "lifecycle": "start", "initialIsOpen": true } @@ -512,32 +561,36 @@ "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": [], + "signature": [ + "() => ", + "CasesClient" + ], "source": { "path": "x-pack/plugins/cases/server/types.ts", "lineNumber": 13 }, - "signature": [ - "() => ", - "CasesClient" - ] + "deprecated": false } ], - "source": { - "path": "x-pack/plugins/cases/server/types.ts", - "lineNumber": 12 - }, "initialIsOpen": false } ], @@ -549,575 +602,671 @@ "classes": [], "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", - "isRequired": true, + "description": [], "signature": [ "string" ], - "description": [], "source": { "path": "x-pack/plugins/cases/common/api/runtime_types.ts", "lineNumber": 49 - } + }, + "deprecated": false, + "isRequired": true } ], - "signature": [ - "(message: string) => Error" - ], - "description": [], - "label": "createPlainError", - "source": { - "path": "x-pack/plugins/cases/common/api/runtime_types.ts", - "lineNumber": 49 - }, - "tags": [], "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", - "isRequired": true, + "description": [], "signature": [ "Type", "" ], - "description": [], "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", - "isRequired": true, + "description": [], "signature": [ "ErrorFactory" ], - "description": [], "source": { "path": "x-pack/plugins/cases/common/api/runtime_types.ts", "lineNumber": 57 - } + }, + "deprecated": false, + "isRequired": true } ], - "signature": [ - "(runtimeType: ", - "Type", - ", createError?: ErrorFactory) => (inputValue: I) => A" - ], - "description": [], - "label": "decodeOrThrow", - "source": { - "path": "x-pack/plugins/cases/common/api/runtime_types.ts", - "lineNumber": 55 - }, - "tags": [], "returnComment": [], "initialIsOpen": false }, { + "parentPluginId": "cases", "id": "def-common.excess", "type": "Function", + "tags": [], "label": "excess", + "description": [], "signature": [ "(codec: C) => C" ], - "description": [], + "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", - "isRequired": true, + "description": [], "signature": [ "C" ], - "description": [], "source": { "path": "x-pack/plugins/cases/common/api/runtime_types.ts", "lineNumber": 71 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], "returnComment": [], - "source": { - "path": "x-pack/plugins/cases/common/api/runtime_types.ts", - "lineNumber": 71 - }, "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", - "isRequired": true, + "description": [], "signature": [ "Errors" ], - "description": [], "source": { "path": "x-pack/plugins/cases/common/api/runtime_types.ts", "lineNumber": 20 - } + }, + "deprecated": false, + "isRequired": true } ], - "signature": [ - "(errors: ", - "Errors", - ") => string[]" - ], - "description": [], - "label": "formatErrors", - "source": { - "path": "x-pack/plugins/cases/common/api/runtime_types.ts", - "lineNumber": 20 - }, - "tags": [ - "deprecated" - ], "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", - "isRequired": true, + "description": [], "signature": [ "string" ], - "description": [], "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", - "isRequired": true, + "description": [], "signature": [ "string" ], - "description": [], "source": { "path": "x-pack/plugins/cases/common/api/helpers.ts", "lineNumber": 35 - } + }, + "deprecated": false, + "isRequired": true } ], - "signature": [ - "(caseId: string, commentId: string) => string" - ], - "description": [], - "label": "getCaseCommentDetailsUrl", - "source": { - "path": "x-pack/plugins/cases/common/api/helpers.ts", - "lineNumber": 35 - }, - "tags": [], "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", - "isRequired": true, + "description": [], "signature": [ "string" ], - "description": [], "source": { "path": "x-pack/plugins/cases/common/api/helpers.ts", "lineNumber": 31 - } + }, + "deprecated": false, + "isRequired": true } ], - "signature": [ - "(id: string) => string" - ], - "description": [], - "label": "getCaseCommentsUrl", - "source": { - "path": "x-pack/plugins/cases/common/api/helpers.ts", - "lineNumber": 31 - }, - "tags": [], "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", - "isRequired": true, + "description": [], "signature": [ "string" ], - "description": [], "source": { "path": "x-pack/plugins/cases/common/api/helpers.ts", "lineNumber": 19 - } + }, + "deprecated": false, + "isRequired": true } ], - "signature": [ - "(id: string) => string" - ], - "description": [], - "label": "getCaseDetailsUrl", - "source": { - "path": "x-pack/plugins/cases/common/api/helpers.ts", - "lineNumber": 19 - }, - "tags": [], "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", - "isRequired": true, + "description": [], "signature": [ "string" ], - "description": [], "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", - "isRequired": true, + "description": [], "signature": [ "string" ], - "description": [], "source": { "path": "x-pack/plugins/cases/common/api/helpers.ts", "lineNumber": 47 - } + }, + "deprecated": false, + "isRequired": true } ], - "signature": [ - "(caseId: string, connectorId: string) => string" - ], - "description": [], - "label": "getCasePushUrl", - "source": { - "path": "x-pack/plugins/cases/common/api/helpers.ts", - "lineNumber": 47 - }, - "tags": [], "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", - "isRequired": true, + "description": [], "signature": [ "string" ], - "description": [], "source": { "path": "x-pack/plugins/cases/common/api/helpers.ts", "lineNumber": 39 - } + }, + "deprecated": false, + "isRequired": true } ], - "signature": [ - "(id: string) => string" - ], - "description": [], - "label": "getCaseUserActionUrl", - "source": { - "path": "x-pack/plugins/cases/common/api/helpers.ts", - "lineNumber": 39 - }, - "tags": [], "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", - "isRequired": true, + "description": [], "signature": [ "string" ], - "description": [], "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", - "isRequired": true, + "description": [], "signature": [ "string" ], - "description": [], "source": { "path": "x-pack/plugins/cases/common/api/helpers.ts", "lineNumber": 27 - } + }, + "deprecated": false, + "isRequired": true } ], - "signature": [ - "(caseID: string, subCaseId: string) => string" - ], - "description": [], - "label": "getSubCaseDetailsUrl", - "source": { - "path": "x-pack/plugins/cases/common/api/helpers.ts", - "lineNumber": 27 - }, - "tags": [], "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", - "isRequired": true, + "description": [], "signature": [ "string" ], - "description": [], "source": { "path": "x-pack/plugins/cases/common/api/helpers.ts", "lineNumber": 23 - } + }, + "deprecated": false, + "isRequired": true } ], - "signature": [ - "(caseID: string) => string" - ], - "description": [], - "label": "getSubCasesUrl", - "source": { - "path": "x-pack/plugins/cases/common/api/helpers.ts", - "lineNumber": 23 - }, - "tags": [], "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", - "isRequired": true, + "description": [], "signature": [ "string" ], - "description": [], "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", - "isRequired": true, + "description": [], "signature": [ "string" ], - "description": [], "source": { "path": "x-pack/plugins/cases/common/api/helpers.ts", "lineNumber": 43 - } + }, + "deprecated": false, + "isRequired": true } ], - "signature": [ - "(caseID: string, subCaseId: string) => string" - ], - "description": [], - "label": "getSubCaseUserActionUrl", - "source": { - "path": "x-pack/plugins/cases/common/api/helpers.ts", - "lineNumber": 43 - }, - "tags": [], "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", - "isRequired": true, + "description": [], "signature": [ "ErrorFactory" ], - "description": [], "source": { "path": "x-pack/plugins/cases/common/api/runtime_types.ts", "lineNumber": 51 - } + }, + "deprecated": false, + "isRequired": true } ], - "signature": [ - "(createError: ErrorFactory) => (errors: ", - "Errors", - ") => never" - ], - "description": [], - "label": "throwErrors", - "source": { - "path": "x-pack/plugins/cases/common/api/runtime_types.ts", - "lineNumber": 51 - }, - "tags": [], "returnComment": [], "initialIsOpen": false } ], "interfaces": [ { + "parentPluginId": "cases", "id": "def-common.ActionLicense", "type": "Interface", + "tags": [], "label": "ActionLicense", "description": [], - "tags": [], + "source": { + "path": "x-pack/plugins/cases/common/ui/types.ts", + "lineNumber": 144 + }, + "deprecated": false, "children": [ { - "tags": [], + "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 }, { - "tags": [], + "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 }, { - "tags": [], + "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 }, { - "tags": [], + "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 }, { - "tags": [], + "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 } ], - "source": { - "path": "x-pack/plugins/cases/common/ui/types.ts", - "lineNumber": 144 - }, "initialIsOpen": false }, { + "parentPluginId": "cases", "id": "def-common.AllCases", "type": "Interface", + "tags": [], "label": "AllCases", + "description": [], "signature": [ { "pluginId": "cases", @@ -1135,19 +1284,19 @@ "text": "CasesStatus" } ], - "description": [], - "tags": [], + "source": { + "path": "x-pack/plugins/cases/common/ui/types.ts", + "lineNumber": 112 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "cases", "id": "def-common.AllCases.cases", "type": "Array", + "tags": [], "label": "cases", "description": [], - "source": { - "path": "x-pack/plugins/cases/common/ui/types.ts", - "lineNumber": 113 - }, "signature": [ { "pluginId": "cases", @@ -1157,127 +1306,149 @@ "text": "Case" }, "[]" - ] + ], + "source": { + "path": "x-pack/plugins/cases/common/ui/types.ts", + "lineNumber": 113 + }, + "deprecated": false }, { - "tags": [], + "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 }, { - "tags": [], + "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 }, { - "tags": [], + "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 } ], - "source": { - "path": "x-pack/plugins/cases/common/ui/types.ts", - "lineNumber": 112 - }, "initialIsOpen": false }, { + "parentPluginId": "cases", "id": "def-common.ApiProps", "type": "Interface", + "tags": [], "label": "ApiProps", "description": [], - "tags": [], + "source": { + "path": "x-pack/plugins/cases/common/ui/types.ts", + "lineNumber": 135 + }, + "deprecated": false, "children": [ { - "tags": [], + "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 }, - "signature": [ - "AbortSignal" - ] + "deprecated": false } ], - "source": { - "path": "x-pack/plugins/cases/common/ui/types.ts", - "lineNumber": 135 - }, "initialIsOpen": false }, { + "parentPluginId": "cases", "id": "def-common.BulkUpdateStatus", "type": "Interface", + "tags": [], "label": "BulkUpdateStatus", "description": [], - "tags": [], + "source": { + "path": "x-pack/plugins/cases/common/ui/types.ts", + "lineNumber": 139 + }, + "deprecated": false, "children": [ { - "tags": [], + "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 }, { - "tags": [], + "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 }, { - "tags": [], + "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 } ], - "source": { - "path": "x-pack/plugins/cases/common/ui/types.ts", - "lineNumber": 139 - }, "initialIsOpen": false }, { + "parentPluginId": "cases", "id": "def-common.Case", "type": "Interface", + "tags": [], "label": "Case", + "description": [], "signature": [ { "pluginId": "cases", @@ -1288,19 +1459,19 @@ }, " extends BasicCase" ], - "description": [], - "tags": [], + "source": { + "path": "x-pack/plugins/cases/common/ui/types.ts", + "lineNumber": 80 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "cases", "id": "def-common.Case.connector", "type": "CompoundType", + "tags": [], "label": "connector", "description": [], - "source": { - "path": "x-pack/plugins/cases/common/ui/types.ts", - "lineNumber": 81 - }, "signature": [ "({ id: string; name: string; } & { type: ", { @@ -1342,29 +1513,33 @@ "section": "def-common.ConnectorTypes", "text": "ConnectorTypes" } - ] + ], + "source": { + "path": "x-pack/plugins/cases/common/ui/types.ts", + "lineNumber": 81 + }, + "deprecated": false }, { - "tags": [], + "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 }, { - "tags": [], + "parentPluginId": "cases", "id": "def-common.Case.externalService", "type": "CompoundType", + "tags": [], "label": "externalService", "description": [], - "source": { - "path": "x-pack/plugins/cases/common/ui/types.ts", - "lineNumber": 83 - }, "signature": [ { "pluginId": "cases", @@ -1374,18 +1549,20 @@ "text": "CaseExternalService" }, " | null" - ] + ], + "source": { + "path": "x-pack/plugins/cases/common/ui/types.ts", + "lineNumber": 83 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "cases", "id": "def-common.Case.subCases", "type": "CompoundType", + "tags": [], "label": "subCases", "description": [], - "source": { - "path": "x-pack/plugins/cases/common/ui/types.ts", - "lineNumber": 84 - }, "signature": [ { "pluginId": "cases", @@ -1395,60 +1572,68 @@ "text": "SubCase" }, "[] | null | undefined" - ] + ], + "source": { + "path": "x-pack/plugins/cases/common/ui/types.ts", + "lineNumber": 84 + }, + "deprecated": false }, { - "tags": [], + "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 }, - "signature": [ - "string[]" - ] + "deprecated": false }, { - "tags": [], + "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 }, - "signature": [ - "{ syncAlerts: boolean; }" - ] + "deprecated": false }, { - "tags": [], + "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 }, - "signature": [ - "string[]" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "cases", "id": "def-common.Case.type", "type": "Enum", + "tags": [], "label": "type", "description": [], - "source": { - "path": "x-pack/plugins/cases/common/ui/types.ts", - "lineNumber": 88 - }, "signature": [ { "pluginId": "cases", @@ -1457,43 +1642,49 @@ "section": "def-common.CaseType", "text": "CaseType" } - ] + ], + "source": { + "path": "x-pack/plugins/cases/common/ui/types.ts", + "lineNumber": 88 + }, + "deprecated": false } ], - "source": { - "path": "x-pack/plugins/cases/common/ui/types.ts", - "lineNumber": 80 - }, "initialIsOpen": false }, { + "parentPluginId": "cases", "id": "def-common.CaseExternalService", "type": "Interface", + "tags": [], "label": "CaseExternalService", "description": [], - "tags": [], + "source": { + "path": "x-pack/plugins/cases/common/ui/types.ts", + "lineNumber": 49 + }, + "deprecated": false, "children": [ { - "tags": [], + "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 }, { - "tags": [], + "parentPluginId": "cases", "id": "def-common.CaseExternalService.pushedBy", "type": "Object", + "tags": [], "label": "pushedBy", "description": [], - "source": { - "path": "x-pack/plugins/cases/common/ui/types.ts", - "lineNumber": 51 - }, "signature": [ { "pluginId": "cases", @@ -1502,193 +1693,223 @@ "section": "def-common.ElasticUser", "text": "ElasticUser" } - ] + ], + "source": { + "path": "x-pack/plugins/cases/common/ui/types.ts", + "lineNumber": 51 + }, + "deprecated": false }, { - "tags": [], + "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 }, { - "tags": [], + "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 }, { - "tags": [], + "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 }, { - "tags": [], + "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 }, { - "tags": [], + "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 } ], - "source": { - "path": "x-pack/plugins/cases/common/ui/types.ts", - "lineNumber": 49 - }, "initialIsOpen": false }, { + "parentPluginId": "cases", "id": "def-common.CasesStatus", "type": "Interface", + "tags": [], "label": "CasesStatus", "description": [], - "tags": [], + "source": { + "path": "x-pack/plugins/cases/common/ui/types.ts", + "lineNumber": 106 + }, + "deprecated": false, "children": [ { - "tags": [], + "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 }, - "signature": [ - "number | null" - ] + "deprecated": false }, { - "tags": [], + "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 }, - "signature": [ - "number | null" - ] + "deprecated": false }, { - "tags": [], + "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 }, - "signature": [ - "number | null" - ] + "deprecated": false } ], - "source": { - "path": "x-pack/plugins/cases/common/ui/types.ts", - "lineNumber": 106 - }, "initialIsOpen": false }, { + "parentPluginId": "cases", "id": "def-common.CaseUserActions", "type": "Interface", + "tags": [], "label": "CaseUserActions", "description": [], - "tags": [], + "source": { + "path": "x-pack/plugins/cases/common/ui/types.ts", + "lineNumber": 37 + }, + "deprecated": false, "children": [ { - "tags": [], + "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 }, { - "tags": [], + "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 }, - "signature": [ - "(\"status\" | \"description\" | \"title\" | \"comment\" | \"tags\" | \"settings\" | \"connector\" | \"pushed\" | \"sub_case\")[]" - ] + "deprecated": false }, { - "tags": [], + "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 }, - "signature": [ - "\"add\" | \"delete\" | \"create\" | \"update\" | \"push-to-service\"" - ] + "deprecated": false }, { - "tags": [], + "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 }, { - "tags": [], + "parentPluginId": "cases", "id": "def-common.CaseUserActions.actionBy", "type": "Object", + "tags": [], "label": "actionBy", "description": [], - "source": { - "path": "x-pack/plugins/cases/common/ui/types.ts", - "lineNumber": 42 - }, "signature": [ { "pluginId": "cases", @@ -1697,96 +1918,110 @@ "section": "def-common.ElasticUser", "text": "ElasticUser" } - ] + ], + "source": { + "path": "x-pack/plugins/cases/common/ui/types.ts", + "lineNumber": 42 + }, + "deprecated": false }, { - "tags": [], + "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 }, { - "tags": [], + "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 }, - "signature": [ - "string | null" - ] + "deprecated": false }, { - "tags": [], + "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 }, - "signature": [ - "string | null" - ] + "deprecated": false }, { - "tags": [], + "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 }, - "signature": [ - "string | null" - ] + "deprecated": false } ], - "source": { - "path": "x-pack/plugins/cases/common/ui/types.ts", - "lineNumber": 37 - }, "initialIsOpen": false }, { + "parentPluginId": "cases", "id": "def-common.DeleteCase", "type": "Interface", + "tags": [], "label": "DeleteCase", "description": [], - "tags": [], + "source": { + "path": "x-pack/plugins/cases/common/ui/types.ts", + "lineNumber": 152 + }, + "deprecated": false, "children": [ { - "tags": [], + "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 }, { - "tags": [], + "parentPluginId": "cases", "id": "def-common.DeleteCase.type", "type": "CompoundType", + "tags": [], "label": "type", "description": [], - "source": { - "path": "x-pack/plugins/cases/common/ui/types.ts", - "lineNumber": 154 - }, "signature": [ { "pluginId": "cases", @@ -1796,71 +2031,81 @@ "text": "CaseType" }, " | null" - ] + ], + "source": { + "path": "x-pack/plugins/cases/common/ui/types.ts", + "lineNumber": 154 + }, + "deprecated": false }, { - "tags": [], + "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 }, - "signature": [ - "string | undefined" - ] + "deprecated": false } ], - "source": { - "path": "x-pack/plugins/cases/common/ui/types.ts", - "lineNumber": 152 - }, "initialIsOpen": false }, { + "parentPluginId": "cases", "id": "def-common.Ecs", "type": "Interface", + "tags": [], "label": "Ecs", "description": [], - "tags": [], + "source": { + "path": "x-pack/plugins/cases/common/ui/types.ts", + "lineNumber": 225 + }, + "deprecated": false, "children": [ { - "tags": [], + "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 }, { - "tags": [], + "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 }, - "signature": [ - "string | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "cases", "id": "def-common.Ecs.signal", "type": "Object", + "tags": [], "label": "signal", "description": [], - "source": { - "path": "x-pack/plugins/cases/common/ui/types.ts", - "lineNumber": 228 - }, "signature": [ { "pluginId": "cases", @@ -1870,110 +2115,126 @@ "text": "SignalEcs" }, " | undefined" - ] + ], + "source": { + "path": "x-pack/plugins/cases/common/ui/types.ts", + "lineNumber": 228 + }, + "deprecated": false } ], - "source": { - "path": "x-pack/plugins/cases/common/ui/types.ts", - "lineNumber": 225 - }, "initialIsOpen": false }, { + "parentPluginId": "cases", "id": "def-common.ElasticUser", "type": "Interface", + "tags": [], "label": "ElasticUser", "description": [], - "tags": [], + "source": { + "path": "x-pack/plugins/cases/common/ui/types.ts", + "lineNumber": 124 + }, + "deprecated": false, "children": [ { - "tags": [], + "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 }, - "signature": [ - "string | null | undefined" - ] + "deprecated": false }, { - "tags": [], + "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 }, - "signature": [ - "string | null | undefined" - ] + "deprecated": false }, { - "tags": [], + "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 }, - "signature": [ - "string | null | undefined" - ] + "deprecated": false } ], - "source": { - "path": "x-pack/plugins/cases/common/ui/types.ts", - "lineNumber": 124 - }, "initialIsOpen": false }, { + "parentPluginId": "cases", "id": "def-common.ESCaseConnector", "type": "Interface", + "tags": [], "label": "ESCaseConnector", "description": [], - "tags": [], + "source": { + "path": "x-pack/plugins/cases/common/api/connectors/index.ts", + "lineNumber": 100 + }, + "deprecated": false, "children": [ { - "tags": [], + "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 }, { - "tags": [], + "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 }, { - "tags": [], + "parentPluginId": "cases", "id": "def-common.ESCaseConnector.type", "type": "Enum", + "tags": [], "label": "type", "description": [], - "source": { - "path": "x-pack/plugins/cases/common/api/connectors/index.ts", - "lineNumber": 103 - }, "signature": [ { "pluginId": "cases", @@ -1982,18 +2243,20 @@ "section": "def-common.ConnectorTypes", "text": "ConnectorTypes" } - ] + ], + "source": { + "path": "x-pack/plugins/cases/common/api/connectors/index.ts", + "lineNumber": 103 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "cases", "id": "def-common.ESCaseConnector.fields", "type": "CompoundType", + "tags": [], "label": "fields", "description": [], - "source": { - "path": "x-pack/plugins/cases/common/api/connectors/index.ts", - "lineNumber": 104 - }, "signature": [ { "pluginId": "cases", @@ -2003,19 +2266,23 @@ "text": "ESConnectorFields" }, " | null" - ] + ], + "source": { + "path": "x-pack/plugins/cases/common/api/connectors/index.ts", + "lineNumber": 104 + }, + "deprecated": false } ], - "source": { - "path": "x-pack/plugins/cases/common/api/connectors/index.ts", - "lineNumber": 100 - }, "initialIsOpen": false }, { + "parentPluginId": "cases", "id": "def-common.FetchCasesProps", "type": "Interface", + "tags": [], "label": "FetchCasesProps", + "description": [], "signature": [ { "pluginId": "cases", @@ -2033,19 +2300,19 @@ "text": "ApiProps" } ], - "description": [], - "tags": [], + "source": { + "path": "x-pack/plugins/cases/common/ui/types.ts", + "lineNumber": 130 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "cases", "id": "def-common.FetchCasesProps.queryParams", "type": "Object", + "tags": [], "label": "queryParams", "description": [], - "source": { - "path": "x-pack/plugins/cases/common/ui/types.ts", - "lineNumber": 131 - }, "signature": [ { "pluginId": "cases", @@ -2055,18 +2322,20 @@ "text": "QueryParams" }, " | undefined" - ] + ], + "source": { + "path": "x-pack/plugins/cases/common/ui/types.ts", + "lineNumber": 131 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "cases", "id": "def-common.FetchCasesProps.filterOptions", "type": "Object", + "tags": [], "label": "filterOptions", "description": [], - "source": { - "path": "x-pack/plugins/cases/common/ui/types.ts", - "lineNumber": 132 - }, "signature": [ { "pluginId": "cases", @@ -2076,82 +2345,94 @@ "text": "FilterOptions" }, " | undefined" - ] + ], + "source": { + "path": "x-pack/plugins/cases/common/ui/types.ts", + "lineNumber": 132 + }, + "deprecated": false } ], - "source": { - "path": "x-pack/plugins/cases/common/ui/types.ts", - "lineNumber": 130 - }, "initialIsOpen": false }, { + "parentPluginId": "cases", "id": "def-common.FieldMappings", "type": "Interface", + "tags": [], "label": "FieldMappings", "description": [], - "tags": [], + "source": { + "path": "x-pack/plugins/cases/common/ui/types.ts", + "lineNumber": 158 + }, + "deprecated": false, "children": [ { - "tags": [], + "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 }, { - "tags": [], + "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 }, - "signature": [ - "string | undefined" - ] + "deprecated": false } ], - "source": { - "path": "x-pack/plugins/cases/common/ui/types.ts", - "lineNumber": 158 - }, "initialIsOpen": false }, { + "parentPluginId": "cases", "id": "def-common.FilterOptions", "type": "Interface", + "tags": [], "label": "FilterOptions", "description": [], - "tags": [], + "source": { + "path": "x-pack/plugins/cases/common/ui/types.ts", + "lineNumber": 98 + }, + "deprecated": false, "children": [ { - "tags": [], + "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 }, { - "tags": [], + "parentPluginId": "cases", "id": "def-common.FilterOptions.status", "type": "CompoundType", + "tags": [], "label": "status", "description": [], - "source": { - "path": "x-pack/plugins/cases/common/ui/types.ts", - "lineNumber": 100 - }, "signature": [ { "pluginId": "cases", @@ -2160,96 +2441,110 @@ "section": "def-common.CaseStatusWithAllStatus", "text": "CaseStatusWithAllStatus" } - ] + ], + "source": { + "path": "x-pack/plugins/cases/common/ui/types.ts", + "lineNumber": 100 + }, + "deprecated": false }, { - "tags": [], + "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 }, - "signature": [ - "string[]" - ] + "deprecated": false }, { - "tags": [], + "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 }, - "signature": [ - "{ email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; }[]" - ] + "deprecated": false }, { - "tags": [], + "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 }, - "signature": [ - "boolean | undefined" - ] + "deprecated": false } ], - "source": { - "path": "x-pack/plugins/cases/common/ui/types.ts", - "lineNumber": 98 - }, "initialIsOpen": false }, { + "parentPluginId": "cases", "id": "def-common.QueryParams", "type": "Interface", + "tags": [], "label": "QueryParams", "description": [], - "tags": [], + "source": { + "path": "x-pack/plugins/cases/common/ui/types.ts", + "lineNumber": 91 + }, + "deprecated": false, "children": [ { - "tags": [], + "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 }, { - "tags": [], + "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 }, { - "tags": [], + "parentPluginId": "cases", "id": "def-common.QueryParams.sortField", "type": "Enum", + "tags": [], "label": "sortField", "description": [], - "source": { - "path": "x-pack/plugins/cases/common/ui/types.ts", - "lineNumber": 94 - }, "signature": [ { "pluginId": "cases", @@ -2258,536 +2553,612 @@ "section": "def-common.SortFieldCase", "text": "SortFieldCase" } - ] + ], + "source": { + "path": "x-pack/plugins/cases/common/ui/types.ts", + "lineNumber": 94 + }, + "deprecated": false }, { - "tags": [], + "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 }, - "signature": [ - "\"asc\" | \"desc\"" - ] + "deprecated": false } ], - "source": { - "path": "x-pack/plugins/cases/common/ui/types.ts", - "lineNumber": 91 - }, "initialIsOpen": false }, { + "parentPluginId": "cases", "id": "def-common.RuleEcs", "type": "Interface", + "tags": [], "label": "RuleEcs", "description": [], - "tags": [], + "source": { + "path": "x-pack/plugins/cases/common/ui/types.ts", + "lineNumber": 178 + }, + "deprecated": false, "children": [ { - "tags": [], + "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 }, - "signature": [ - "string[] | undefined" - ] + "deprecated": false }, { - "tags": [], + "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 }, - "signature": [ - "string[] | undefined" - ] + "deprecated": false }, { - "tags": [], + "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 }, - "signature": [ - "string[] | undefined" - ] + "deprecated": false }, { - "tags": [], + "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 }, - "signature": [ - "string[]" - ] + "deprecated": false }, { - "tags": [], + "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 }, - "signature": [ - "string[] | undefined" - ] + "deprecated": false }, { - "tags": [], + "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 }, - "signature": [ - "string[] | undefined" - ] + "deprecated": false }, { - "tags": [], + "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 }, - "signature": [ - "string[] | undefined" - ] + "deprecated": false }, { - "tags": [], + "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 }, - "signature": [ - "number[] | undefined" - ] + "deprecated": false }, { - "tags": [], + "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 }, - "signature": [ - "string[] | undefined" - ] + "deprecated": false }, { - "tags": [], + "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 }, - "signature": [ - "string[] | undefined" - ] + "deprecated": false }, { - "tags": [], + "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 }, - "signature": [ - "string[] | undefined" - ] + "deprecated": false }, { - "tags": [], + "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 }, - "signature": [ - "string[] | undefined" - ] + "deprecated": false }, { - "tags": [], + "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 }, - "signature": [ - "boolean[] | undefined" - ] + "deprecated": false }, { - "tags": [], + "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 }, - "signature": [ - "string[] | undefined" - ] + "deprecated": false }, { - "tags": [], + "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 }, - "signature": [ - "string[] | undefined" - ] + "deprecated": false }, { - "tags": [], + "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 }, - "signature": [ - "string[] | undefined" - ] + "deprecated": false }, { - "tags": [], + "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 }, - "signature": [ - "string[] | undefined" - ] + "deprecated": false }, { - "tags": [], + "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 }, - "signature": [ - "string[] | undefined" - ] + "deprecated": false }, { - "tags": [], + "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 }, - "signature": [ - "string[] | undefined" - ] + "deprecated": false }, { - "tags": [], + "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 }, - "signature": [ - "string[] | undefined" - ] + "deprecated": false }, { - "tags": [], + "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 }, - "signature": [ - "unknown" - ] + "deprecated": false }, { - "tags": [], + "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 }, - "signature": [ - "unknown" - ] + "deprecated": false }, { - "tags": [], + "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 }, - "signature": [ - "string[] | undefined" - ] + "deprecated": false }, { - "tags": [], + "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 }, - "signature": [ - "string[] | undefined" - ] + "deprecated": false }, { - "tags": [], + "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 }, - "signature": [ - "string[] | undefined" - ] + "deprecated": false }, { - "tags": [], + "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 }, - "signature": [ - "boolean[] | undefined" - ] + "deprecated": false }, { - "tags": [], + "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 }, - "signature": [ - "unknown" - ] + "deprecated": false }, { - "tags": [], + "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 }, - "signature": [ - "string[] | undefined" - ] + "deprecated": false }, { - "tags": [], + "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 }, - "signature": [ - "string[] | undefined" - ] + "deprecated": false }, { - "tags": [], + "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 }, - "signature": [ - "string[] | undefined" - ] + "deprecated": false }, { - "tags": [], + "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 }, - "signature": [ - "string[] | undefined" - ] + "deprecated": false }, { - "tags": [], + "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 }, - "signature": [ - "string[] | undefined" - ] + "deprecated": false }, { - "tags": [], + "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 }, - "signature": [ - "string[] | undefined" - ] + "deprecated": false }, { - "tags": [], + "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 }, - "signature": [ - "string[] | undefined" - ] + "deprecated": false } ], - "source": { - "path": "x-pack/plugins/cases/common/ui/types.ts", - "lineNumber": 178 - }, "initialIsOpen": false }, { + "parentPluginId": "cases", "id": "def-common.SignalEcs", "type": "Interface", + "tags": [], "label": "SignalEcs", "description": [], - "tags": [], + "source": { + "path": "x-pack/plugins/cases/common/ui/types.ts", + "lineNumber": 215 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "cases", "id": "def-common.SignalEcs.rule", "type": "Object", + "tags": [], "label": "rule", "description": [], - "source": { - "path": "x-pack/plugins/cases/common/ui/types.ts", - "lineNumber": 216 - }, "signature": [ { "pluginId": "cases", @@ -2797,75 +3168,87 @@ "text": "RuleEcs" }, " | undefined" - ] + ], + "source": { + "path": "x-pack/plugins/cases/common/ui/types.ts", + "lineNumber": 216 + }, + "deprecated": false }, { - "tags": [], + "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 }, - "signature": [ - "string[] | undefined" - ] + "deprecated": false }, { - "tags": [], + "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 }, - "signature": [ - "string[] | undefined" - ] + "deprecated": false }, { - "tags": [], + "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 }, - "signature": [ - "{ id?: string[] | undefined; } | undefined" - ] + "deprecated": false }, { - "tags": [], + "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 }, - "signature": [ - "unknown" - ] + "deprecated": false } ], - "source": { - "path": "x-pack/plugins/cases/common/ui/types.ts", - "lineNumber": 215 - }, "initialIsOpen": false }, { + "parentPluginId": "cases", "id": "def-common.SubCase", "type": "Interface", + "tags": [], "label": "SubCase", + "description": [], "signature": [ { "pluginId": "cases", @@ -2876,19 +3259,19 @@ }, " extends BasicCase" ], - "description": [], - "tags": [], + "source": { + "path": "x-pack/plugins/cases/common/ui/types.ts", + "lineNumber": 75 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "cases", "id": "def-common.SubCase.associationType", "type": "Enum", + "tags": [], "label": "associationType", "description": [], - "source": { - "path": "x-pack/plugins/cases/common/ui/types.ts", - "lineNumber": 76 - }, "signature": [ { "pluginId": "cases", @@ -2897,57 +3280,65 @@ "section": "def-common.AssociationType", "text": "AssociationType" } - ] + ], + "source": { + "path": "x-pack/plugins/cases/common/ui/types.ts", + "lineNumber": 76 + }, + "deprecated": false }, { - "tags": [], + "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 } ], - "source": { - "path": "x-pack/plugins/cases/common/ui/types.ts", - "lineNumber": 75 - }, "initialIsOpen": false }, { + "parentPluginId": "cases", "id": "def-common.UpdateByKey", "type": "Interface", + "tags": [], "label": "UpdateByKey", "description": [], - "tags": [], + "source": { + "path": "x-pack/plugins/cases/common/ui/types.ts", + "lineNumber": 168 + }, + "deprecated": false, "children": [ { - "tags": [], + "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 }, - "signature": [ - "\"status\" | \"description\" | \"title\" | \"tags\" | \"settings\" | \"connector\"" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "cases", "id": "def-common.UpdateByKey.updateValue", "type": "CompoundType", + "tags": [], "label": "updateValue", "description": [], - "source": { - "path": "x-pack/plugins/cases/common/ui/types.ts", - "lineNumber": 170 - }, "signature": [ "string | string[] | ({ id: string; name: string; } & { type: ", { @@ -2989,32 +3380,36 @@ "section": "def-common.ConnectorTypes", "text": "ConnectorTypes" } - ] + ], + "source": { + "path": "x-pack/plugins/cases/common/ui/types.ts", + "lineNumber": 170 + }, + "deprecated": false }, { - "tags": [], + "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 }, - "signature": [ - "((caseId: string, caseConnectorId: string, subCaseId?: string | undefined) => void) | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "cases", "id": "def-common.UpdateByKey.updateCase", "type": "Function", + "tags": [], "label": "updateCase", "description": [], - "source": { - "path": "x-pack/plugins/cases/common/ui/types.ts", - "lineNumber": 172 - }, "signature": [ "((newCase: ", { @@ -3025,18 +3420,20 @@ "text": "Case" }, ") => void) | undefined" - ] + ], + "source": { + "path": "x-pack/plugins/cases/common/ui/types.ts", + "lineNumber": 172 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "cases", "id": "def-common.UpdateByKey.caseData", "type": "Object", + "tags": [], "label": "caseData", "description": [], - "source": { - "path": "x-pack/plugins/cases/common/ui/types.ts", - "lineNumber": 173 - }, "signature": [ { "pluginId": "cases", @@ -3045,50 +3442,56 @@ "section": "def-common.Case", "text": "Case" } - ] + ], + "source": { + "path": "x-pack/plugins/cases/common/ui/types.ts", + "lineNumber": 173 + }, + "deprecated": false }, { - "tags": [], + "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 }, - "signature": [ - "(() => void) | undefined" - ] + "deprecated": false }, { - "tags": [], + "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 }, - "signature": [ - "(() => void) | undefined" - ] + "deprecated": false } ], - "source": { - "path": "x-pack/plugins/cases/common/ui/types.ts", - "lineNumber": 168 - }, "initialIsOpen": false } ], "enums": [ { + "parentPluginId": "cases", "id": "def-common.AssociationType", "type": "Enum", - "label": "AssociationType", "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." ], @@ -3096,334 +3499,380 @@ "path": "x-pack/plugins/cases/common/api/cases/comment.ts", "lineNumber": 33 }, + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "cases", "id": "def-common.CaseStatuses", "type": "Enum", - "label": "CaseStatuses", "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", - "label": "CaseType", "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", - "label": "CommentType", "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", - "label": "ConnectorTypes", "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", - "label": "SortFieldCase", "tags": [], + "label": "SortFieldCase", "description": [], "source": { "path": "x-pack/plugins/cases/common/ui/types.ts", "lineNumber": 119 }, + "deprecated": false, "initialIsOpen": false } ], "misc": [ { - "tags": [], + "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 }, - "signature": [ - "\"/api/actions/list_action_types\"" - ], + "deprecated": false, "initialIsOpen": false }, { - "tags": [], + "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 }, - "signature": [ - "\"/api/actions\"" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "cases", "id": "def-common.ActionConnector", "type": "Type", - "label": "ActionConnector", "tags": [], + "label": "ActionConnector", "description": [], + "signature": [ + "ActionResult" + ], "source": { "path": "x-pack/plugins/cases/common/api/connectors/index.ts", "lineNumber": 22 }, - "signature": [ - "ActionResult" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "cases", "id": "def-common.ActionType", "type": "Type", - "label": "ActionType", "tags": [], + "label": "ActionType", "description": [], + "signature": [ + "\"append\" | \"overwrite\" | \"nothing\"" + ], "source": { "path": "x-pack/plugins/cases/common/api/connectors/mappings.ts", "lineNumber": 22 }, - "signature": [ - "\"append\" | \"overwrite\" | \"nothing\"" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "cases", "id": "def-common.ActionTypeConnector", "type": "Type", - "label": "ActionTypeConnector", "tags": [], + "label": "ActionTypeConnector", "description": [], + "signature": [ + "ActionType" + ], "source": { "path": "x-pack/plugins/cases/common/api/connectors/index.ts", "lineNumber": 23 }, - "signature": [ - "ActionType" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "cases", "id": "def-common.AllCommentsResponse", "type": "Type", - "label": "AllCommentsResponse", "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 }, - "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; }))[]" - ], + "deprecated": false, "initialIsOpen": false }, { - "tags": [], + "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 }, - "signature": [ - "\"cases\"" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "cases", "id": "def-common.AttributesTypeAlerts", "type": "Type", - "label": "AttributesTypeAlerts", "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 }, - "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; }" - ], + "deprecated": false, "initialIsOpen": false }, { - "tags": [], + "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 }, { - "tags": [], + "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 }, { - "tags": [], + "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 }, { - "tags": [], + "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 }, { - "tags": [], + "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 }, { - "tags": [], + "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 }, { - "tags": [], + "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 }, { - "tags": [], + "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 }, { - "tags": [], + "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 }, { - "tags": [], + "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 }, { - "tags": [], + "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", - "label": "CaseAttributes", "tags": [], + "label": "CaseAttributes", "description": [], - "source": { - "path": "x-pack/plugins/cases/common/api/cases/case.ts", - "lineNumber": 175 - }, "signature": [ "{ description: string; status: ", { @@ -3466,18 +3915,20 @@ "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", - "label": "CaseConnector", "tags": [], + "label": "CaseConnector", "description": [], - "source": { - "path": "x-pack/plugins/cases/common/api/connectors/index.ts", - "lineNumber": 82 - }, "signature": [ "{ id: string; name: string; } & { type: ", { @@ -3520,48 +3971,54 @@ "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", - "label": "CaseField", "tags": [], + "label": "CaseField", "description": [], + "signature": [ + "\"description\" | \"title\" | \"comments\"" + ], "source": { "path": "x-pack/plugins/cases/common/api/connectors/mappings.ts", "lineNumber": 23 }, - "signature": [ - "\"description\" | \"title\" | \"comments\"" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "cases", "id": "def-common.CaseFullExternalService", "type": "Type", - "label": "CaseFullExternalService", "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 }, - "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; }; }" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "cases", "id": "def-common.CasePatchRequest", "type": "Type", - "label": "CasePatchRequest", "tags": [], + "label": "CasePatchRequest", "description": [], - "source": { - "path": "x-pack/plugins/cases/common/api/cases/case.ts", - "lineNumber": 187 - }, "signature": [ "{ description?: string | undefined; status?: ", { @@ -3604,18 +4061,20 @@ "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", - "label": "CasePostRequest", "tags": [], + "label": "CasePostRequest", "description": [], - "source": { - "path": "x-pack/plugins/cases/common/api/cases/case.ts", - "lineNumber": 182 - }, "signature": [ "{ type?: CaseType | undefined; } & { description: string; tags: string[]; title: string; connector: ({ id: string; name: string; } & { type: ", { @@ -3658,18 +4117,20 @@ "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", - "label": "CaseResponse", "tags": [], + "label": "CaseResponse", "description": [], - "source": { - "path": "x-pack/plugins/cases/common/api/cases/case.ts", - "lineNumber": 183 - }, "signature": [ "{ description: string; status: ", { @@ -3712,37 +4173,41 @@ "text": "ConnectorTypes" } ], + "source": { + "path": "x-pack/plugins/cases/common/api/cases/case.ts", + "lineNumber": 183 + }, + "deprecated": false, "initialIsOpen": false }, { - "tags": [], + "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 }, - "signature": [ - "\"/api/cases\"" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "cases", "id": "def-common.CasesClientPostRequest", "type": "Type", - "label": "CasesClientPostRequest", "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." ], - "source": { - "path": "x-pack/plugins/cases/common/api/cases/case.ts", - "lineNumber": 181 - }, "signature": [ "{ type: CaseType; description: string; tags: string[]; title: string; connector: ({ id: string; name: string; } & { type: ", { @@ -3785,18 +4250,20 @@ "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", - "label": "CasesConfigure", "tags": [], + "label": "CasesConfigure", "description": [], - "source": { - "path": "x-pack/plugins/cases/common/api/cases/configure.ts", - "lineNumber": 47 - }, "signature": [ "{ connector: ({ id: string; name: string; } & { type: ", { @@ -3839,18 +4306,20 @@ "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", - "label": "CasesConfigureAttributes", "tags": [], + "label": "CasesConfigureAttributes", "description": [], - "source": { - "path": "x-pack/plugins/cases/common/api/cases/configure.ts", - "lineNumber": 50 - }, "signature": [ "{ connector: ({ id: string; name: string; } & { type: ", { @@ -3893,18 +4362,20 @@ "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", - "label": "CasesConfigurePatch", "tags": [], + "label": "CasesConfigurePatch", "description": [], - "source": { - "path": "x-pack/plugins/cases/common/api/cases/configure.ts", - "lineNumber": 49 - }, "signature": [ "{ connector?: ({ id: string; name: string; } & { type: ", { @@ -3947,18 +4418,20 @@ "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", - "label": "CasesConfigureRequest", "tags": [], + "label": "CasesConfigureRequest", "description": [], - "source": { - "path": "x-pack/plugins/cases/common/api/cases/configure.ts", - "lineNumber": 48 - }, "signature": [ "{ connector: ({ id: string; name: string; } & { type: ", { @@ -4001,18 +4474,20 @@ "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", - "label": "CasesConfigureResponse", "tags": [], + "label": "CasesConfigureResponse", "description": [], - "source": { - "path": "x-pack/plugins/cases/common/api/cases/configure.ts", - "lineNumber": 51 - }, "signature": [ "{ connector: ({ id: string; name: string; } & { type: ", { @@ -4055,33 +4530,37 @@ "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", - "label": "CaseSettings", "tags": [], + "label": "CaseSettings", "description": [], + "signature": [ + "{ syncAlerts: boolean; }" + ], "source": { "path": "x-pack/plugins/cases/common/api/cases/case.ts", "lineNumber": 190 }, - "signature": [ - "{ syncAlerts: boolean; }" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "cases", "id": "def-common.CasesFindRequest", "type": "Type", - "label": "CasesFindRequest", "tags": [], + "label": "CasesFindRequest", "description": [], - "source": { - "path": "x-pack/plugins/cases/common/api/cases/case.ts", - "lineNumber": 185 - }, "signature": [ "{ type?: CaseType | undefined; tags?: string | string[] | undefined; status?: ", { @@ -4093,18 +4572,20 @@ }, " | 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", - "label": "CasesFindResponse", "tags": [], + "label": "CasesFindResponse", "description": [], - "source": { - "path": "x-pack/plugins/cases/common/api/cases/case.ts", - "lineNumber": 186 - }, "signature": [ "{ cases: ({ description: string; status: ", { @@ -4147,18 +4628,20 @@ "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", - "label": "CasesPatchRequest", "tags": [], + "label": "CasesPatchRequest", "description": [], - "source": { - "path": "x-pack/plugins/cases/common/api/cases/case.ts", - "lineNumber": 188 - }, "signature": [ "{ cases: ({ description?: string | undefined; status?: ", { @@ -4201,18 +4684,20 @@ "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", - "label": "CasesResponse", "tags": [], + "label": "CasesResponse", "description": [], - "source": { - "path": "x-pack/plugins/cases/common/api/cases/case.ts", - "lineNumber": 184 - }, "signature": [ "({ description: string; status: ", { @@ -4255,33 +4740,37 @@ "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", - "label": "CasesStatusResponse", "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 }, - "signature": [ - "{ count_open_cases: number; count_in_progress_cases: number; count_closed_cases: number; }" - ], + "deprecated": false, "initialIsOpen": false }, { - "tags": [], + "parentPluginId": "cases", "id": "def-common.caseStatuses", "type": "Array", + "tags": [], "label": "caseStatuses", "description": [], - "source": { - "path": "x-pack/plugins/cases/common/api/cases/status.ts", - "lineNumber": 22 - }, "signature": [ { "pluginId": "cases", @@ -4292,18 +4781,20 @@ }, "[]" ], + "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", - "label": "CaseStatusWithAllStatus", "tags": [], + "label": "CaseStatusWithAllStatus", "description": [], - "source": { - "path": "x-pack/plugins/cases/common/ui/types.ts", - "lineNumber": 24 - }, "signature": [ "\"all\" | ", { @@ -4331,80 +4822,90 @@ }, ".closed" ], + "source": { + "path": "x-pack/plugins/cases/common/ui/types.ts", + "lineNumber": 24 + }, + "deprecated": false, "initialIsOpen": false }, { - "tags": [], + "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 }, - "signature": [ - "\"type\"" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "cases", "id": "def-common.CaseUserActionAttributes", "type": "Type", - "label": "CaseUserActionAttributes", "tags": [], + "label": "CaseUserActionAttributes", "description": [], - "source": { - "path": "x-pack/plugins/cases/common/api/cases/user_actions.ts", - "lineNumber": 59 - }, "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", - "label": "CaseUserActionsResponse", "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 }, - "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; })[]" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "cases", "id": "def-common.ClosureType", "type": "Type", - "label": "ClosureType", "tags": [], + "label": "ClosureType", "description": [], + "signature": [ + "\"close-by-user\" | \"close-by-pushing\"" + ], "source": { "path": "x-pack/plugins/cases/common/api/cases/configure.ts", "lineNumber": 46 }, - "signature": [ - "\"close-by-user\" | \"close-by-pushing\"" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "cases", "id": "def-common.Comment", "type": "Type", - "label": "Comment", "tags": [], + "label": "Comment", "description": [], - "source": { - "path": "x-pack/plugins/cases/common/ui/types.ts", - "lineNumber": 26 - }, "signature": [ "{ comment: string; type: ", { @@ -4447,18 +4948,20 @@ "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", - "label": "CommentAttributes", "tags": [], + "label": "CommentAttributes", "description": [], - "source": { - "path": "x-pack/plugins/cases/common/api/cases/comment.ts", - "lineNumber": 131 - }, "signature": [ "{ comment: string; type: ", { @@ -4501,18 +5004,20 @@ "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", - "label": "CommentPatchAttributes", "tags": [], + "label": "CommentPatchAttributes", "description": [], - "source": { - "path": "x-pack/plugins/cases/common/api/cases/comment.ts", - "lineNumber": 138 - }, "signature": [ "{ associationType?: ", { @@ -4548,18 +5053,20 @@ }, " | 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", - "label": "CommentPatchRequest", "tags": [], + "label": "CommentPatchRequest", "description": [], - "source": { - "path": "x-pack/plugins/cases/common/api/cases/comment.ts", - "lineNumber": 137 - }, "signature": [ "{ comment: string; type: ", { @@ -4587,18 +5094,20 @@ }, ".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", - "label": "CommentRequest", "tags": [], + "label": "CommentRequest", "description": [], - "source": { - "path": "x-pack/plugins/cases/common/api/cases/comment.ts", - "lineNumber": 132 - }, "signature": [ "{ comment: string; type: ", { @@ -4626,48 +5135,54 @@ }, ".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", - "label": "CommentRequestAlertType", "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 }, - "signature": [ - "{ type: CommentType.alert | CommentType.generatedAlert; alertId: string | string[]; index: string | string[]; rule: { id: string | null; name: string | null; }; }" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "cases", "id": "def-common.CommentRequestUserType", "type": "Type", - "label": "CommentRequestUserType", "tags": [], + "label": "CommentRequestUserType", "description": [], + "signature": [ + "{ comment: string; type: CommentType.user; }" + ], "source": { "path": "x-pack/plugins/cases/common/api/cases/comment.ts", "lineNumber": 139 }, - "signature": [ - "{ comment: string; type: CommentType.user; }" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "cases", "id": "def-common.CommentResponse", "type": "Type", - "label": "CommentResponse", "tags": [], + "label": "CommentResponse", "description": [], - "source": { - "path": "x-pack/plugins/cases/common/api/cases/comment.ts", - "lineNumber": 133 - }, "signature": [ "{ comment: string; type: ", { @@ -4710,168 +5225,190 @@ "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", - "label": "CommentResponseAlertsType", "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 }, - "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; }" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "cases", "id": "def-common.CommentsResponse", "type": "Type", - "label": "CommentsResponse", "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 }, - "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; }" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "cases", "id": "def-common.ConnectorField", "type": "Type", - "label": "ConnectorField", "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 }, - "signature": [ - "{ id: string; name: string; required: boolean; type: \"text\" | \"textarea\"; }" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "cases", "id": "def-common.ConnectorFields", "type": "Type", - "label": "ConnectorFields", "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 }, - "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; }" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "cases", "id": "def-common.ConnectorJiraTypeFields", "type": "Type", - "label": "ConnectorJiraTypeFields", "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 }, - "signature": [ - "{ type: ConnectorTypes.jira; fields: { issueType: string | null; priority: string | null; parent: string | null; } | null; }" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "cases", "id": "def-common.ConnectorMappings", "type": "Type", - "label": "ConnectorMappings", "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 }, - "signature": [ - "{ mappings: { action_type: \"append\" | \"overwrite\" | \"nothing\"; source: \"description\" | \"title\" | \"comments\"; target: string; }[]; }" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "cases", "id": "def-common.ConnectorMappingsAttributes", "type": "Type", - "label": "ConnectorMappingsAttributes", "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 }, - "signature": [ - "{ action_type: \"append\" | \"overwrite\" | \"nothing\"; source: \"description\" | \"title\" | \"comments\"; target: string; }" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "cases", "id": "def-common.ConnectorResillientTypeFields", "type": "Type", - "label": "ConnectorResillientTypeFields", "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 }, - "signature": [ - "{ type: ConnectorTypes.resilient; fields: { incidentTypes: string[] | null; severityCode: string | null; } | null; }" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "cases", "id": "def-common.ConnectorServiceNowITSMTypeFields", "type": "Type", - "label": "ConnectorServiceNowITSMTypeFields", "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 }, - "signature": [ - "{ type: ConnectorTypes.serviceNowITSM; fields: { impact: string | null; severity: string | null; urgency: string | null; category: string | null; subcategory: string | null; } | null; }" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "cases", "id": "def-common.ConnectorServiceNowSIRTypeFields", "type": "Type", - "label": "ConnectorServiceNowSIRTypeFields", "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 }, - "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; }" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "cases", "id": "def-common.ConnectorTypeFields", "type": "Type", - "label": "ConnectorTypeFields", "tags": [], + "label": "ConnectorTypeFields", "description": [], - "source": { - "path": "x-pack/plugins/cases/common/api/connectors/index.ts", - "lineNumber": 83 - }, "signature": [ "{ type: ", { @@ -4914,65 +5451,73 @@ "text": "ConnectorTypes" } ], + "source": { + "path": "x-pack/plugins/cases/common/api/connectors/index.ts", + "lineNumber": 83 + }, + "deprecated": false, "initialIsOpen": false }, { - "tags": [], + "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 }, - "signature": [ - "\"dateFormat\"" - ], + "deprecated": false, "initialIsOpen": false }, { - "tags": [], + "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 }, - "signature": [ - "\"dateFormat:tz\"" - ], + "deprecated": false, "initialIsOpen": false }, { - "tags": [], + "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 }, - "signature": [ - "false" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "cases", "id": "def-common.ESCaseAttributes", "type": "Type", - "label": "ESCaseAttributes", "tags": [], + "label": "ESCaseAttributes", "description": [], - "source": { - "path": "x-pack/plugins/cases/common/api/cases/case.ts", - "lineNumber": 193 - }, "signature": [ "Pick<{ description: string; status: ", { @@ -5015,18 +5560,20 @@ "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", - "label": "ESCaseConnectorTypes", "tags": [], + "label": "ESCaseConnectorTypes", "description": [], - "source": { - "path": "x-pack/plugins/cases/common/api/connectors/index.ts", - "lineNumber": 99 - }, "signature": [ { "pluginId": "cases", @@ -5068,18 +5615,20 @@ "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", - "label": "ESCasePatchRequest", "tags": [], + "label": "ESCasePatchRequest", "description": [], - "source": { - "path": "x-pack/plugins/cases/common/api/cases/case.ts", - "lineNumber": 194 - }, "signature": [ "Pick<{ description?: string | undefined; status?: ", { @@ -5122,18 +5671,20 @@ "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", - "label": "ESCasesConfigureAttributes", "tags": [], + "label": "ESCasesConfigureAttributes", "description": [], - "source": { - "path": "x-pack/plugins/cases/common/api/cases/configure.ts", - "lineNumber": 53 - }, "signature": [ "Pick<{ connector: ({ id: string; name: string; } & { type: ", { @@ -5176,323 +5727,367 @@ "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", - "label": "ESConnectorFields", "tags": [], + "label": "ESConnectorFields", "description": [], - "source": { - "path": "x-pack/plugins/cases/common/api/connectors/index.ts", - "lineNumber": 94 - }, "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", - "label": "ExternalServiceResponse", "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 }, - "signature": [ - "{ title: string; id: string; pushedDate: string; url: string; } & { comments?: ({ commentId: string; pushedDate: string; } & { externalCommentId?: string | undefined; })[] | undefined; }" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "cases", "id": "def-common.GetCaseIdsByAlertIdAggs", "type": "Type", - "label": "GetCaseIdsByAlertIdAggs", "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 }, - "signature": [ - "{ references: { doc_count: number; caseIds: { buckets: { key: string; }[]; }; }; }" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "cases", "id": "def-common.GetFieldsResponse", "type": "Type", - "label": "GetFieldsResponse", "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 }, - "signature": [ - "{ defaultMappings: { action_type: \"append\" | \"overwrite\" | \"nothing\"; source: \"description\" | \"title\" | \"comments\"; target: string; }[]; fields: { id: string; name: string; required: boolean; type: \"text\" | \"textarea\"; }[]; }" - ], + "deprecated": false, "initialIsOpen": false }, { - "tags": [], + "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 }, - "signature": [ - "\".jira\"" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "cases", "id": "def-common.JiraFieldsType", "type": "Type", - "label": "JiraFieldsType", "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 }, - "signature": [ - "{ issueType: string | null; priority: string | null; parent: string | null; }" - ], + "deprecated": false, "initialIsOpen": false }, { - "tags": [], + "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 }, - "signature": [ - "5000" - ], + "deprecated": false, "initialIsOpen": false }, { - "tags": [], + "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 }, - "signature": [ - "50" - ], + "deprecated": false, "initialIsOpen": false }, { - "tags": [], + "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 }, - "signature": [ - "\".resilient\"" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "cases", "id": "def-common.ResilientFieldsType", "type": "Type", - "label": "ResilientFieldsType", "tags": [], + "label": "ResilientFieldsType", "description": [], + "signature": [ + "{ incidentTypes: string[] | null; severityCode: string | null; }" + ], "source": { "path": "x-pack/plugins/cases/common/api/connectors/resilient.ts", "lineNumber": 16 }, - "signature": [ - "{ incidentTypes: string[] | null; severityCode: string | null; }" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "cases", "id": "def-common.SavedObjectFindOptions", "type": "Type", - "label": "SavedObjectFindOptions", "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 }, - "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; }" - ], + "deprecated": false, "initialIsOpen": false }, { - "tags": [], + "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 }, - "signature": [ - "\".servicenow\"" - ], + "deprecated": false, "initialIsOpen": false }, { - "tags": [], + "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 }, - "signature": [ - "\".servicenow-sir\"" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "cases", "id": "def-common.ServiceNowITSMFieldsType", "type": "Type", - "label": "ServiceNowITSMFieldsType", "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 }, - "signature": [ - "{ impact: string | null; severity: string | null; urgency: string | null; category: string | null; subcategory: string | null; }" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "cases", "id": "def-common.ServiceNowSIRFieldsType", "type": "Type", - "label": "ServiceNowSIRFieldsType", "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 }, - "signature": [ - "{ category: string | null; destIp: boolean | null; malwareHash: boolean | null; malwareUrl: boolean | null; priority: string | null; sourceIp: boolean | null; subcategory: string | null; }" - ], + "deprecated": false, "initialIsOpen": false }, { - "tags": [], + "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 }, - "signature": [ - "\"all\"" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "cases", "id": "def-common.StatusAllType", "type": "Type", - "label": "StatusAllType", "tags": [], + "label": "StatusAllType", "description": [], + "signature": [ + "\"all\"" + ], "source": { "path": "x-pack/plugins/cases/common/ui/types.ts", "lineNumber": 22 }, - "signature": [ - "\"all\"" - ], + "deprecated": false, "initialIsOpen": false }, { - "tags": [], + "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 }, { - "tags": [], + "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 }, { - "tags": [], + "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 }, { - "tags": [], + "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", - "label": "SubCaseAttributes", "tags": [], + "label": "SubCaseAttributes", "description": [], - "source": { - "path": "x-pack/plugins/cases/common/api/cases/sub_case.ts", - "lineNumber": 75 - }, "signature": [ "{ status: ", { @@ -5504,18 +6099,20 @@ }, "; } & { 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", - "label": "SubCasePatchRequest", "tags": [], + "label": "SubCasePatchRequest", "description": [], - "source": { - "path": "x-pack/plugins/cases/common/api/cases/sub_case.ts", - "lineNumber": 79 - }, "signature": [ "{ status?: ", { @@ -5527,18 +6124,20 @@ }, " | 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", - "label": "SubCaseResponse", "tags": [], + "label": "SubCaseResponse", "description": [], - "source": { - "path": "x-pack/plugins/cases/common/api/cases/sub_case.ts", - "lineNumber": 76 - }, "signature": [ "{ status: ", { @@ -5581,18 +6180,20 @@ "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", - "label": "SubCasesFindResponse", "tags": [], + "label": "SubCasesFindResponse", "description": [], - "source": { - "path": "x-pack/plugins/cases/common/api/cases/sub_case.ts", - "lineNumber": 78 - }, "signature": [ "{ subCases: ({ status: ", { @@ -5635,18 +6236,20 @@ "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", - "label": "SubCasesPatchRequest", "tags": [], + "label": "SubCasesPatchRequest", "description": [], - "source": { - "path": "x-pack/plugins/cases/common/api/cases/sub_case.ts", - "lineNumber": 80 - }, "signature": [ "{ subCases: ({ status?: ", { @@ -5658,18 +6261,20 @@ }, " | 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", - "label": "SubCasesResponse", "tags": [], + "label": "SubCasesResponse", "description": [], - "source": { - "path": "x-pack/plugins/cases/common/api/cases/sub_case.ts", - "lineNumber": 77 - }, "signature": [ "({ status: ", { @@ -5712,127 +6317,143 @@ "text": "CommentType" } ], + "source": { + "path": "x-pack/plugins/cases/common/api/cases/sub_case.ts", + "lineNumber": 77 + }, + "deprecated": false, "initialIsOpen": false }, { - "tags": [], + "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 }, - "signature": [ - "string[]" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "cases", "id": "def-common.ThirdPartyField", "type": "Type", - "label": "ThirdPartyField", "tags": [], + "label": "ThirdPartyField", "description": [], + "signature": [ + "string" + ], "source": { "path": "x-pack/plugins/cases/common/api/connectors/mappings.ts", "lineNumber": 24 }, - "signature": [ - "string" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "cases", "id": "def-common.UpdateKey", "type": "Type", - "label": "UpdateKey", "tags": [], + "label": "UpdateKey", "description": [], + "signature": [ + "\"status\" | \"description\" | \"title\" | \"tags\" | \"settings\" | \"connector\"" + ], "source": { "path": "x-pack/plugins/cases/common/ui/types.ts", "lineNumber": 163 }, - "signature": [ - "\"status\" | \"description\" | \"title\" | \"tags\" | \"settings\" | \"connector\"" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "cases", "id": "def-common.User", "type": "Type", - "label": "User", "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 }, - "signature": [ - "{ email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; }" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "cases", "id": "def-common.UserAction", "type": "Type", - "label": "UserAction", "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 }, - "signature": [ - "\"add\" | \"delete\" | \"create\" | \"update\" | \"push-to-service\"" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "cases", "id": "def-common.UserActionField", "type": "Type", - "label": "UserActionField", "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 }, - "signature": [ - "(\"status\" | \"description\" | \"title\" | \"comment\" | \"tags\" | \"settings\" | \"connector\" | \"pushed\" | \"sub_case\")[]" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "cases", "id": "def-common.UserActionFieldType", "type": "Type", - "label": "UserActionFieldType", "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 }, - "signature": [ - "\"status\" | \"description\" | \"title\" | \"comment\" | \"tags\" | \"settings\" | \"connector\" | \"pushed\" | \"sub_case\"" - ], + "deprecated": false, "initialIsOpen": false } ], "objects": [ { - "tags": [], + "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." ], - "source": { - "path": "x-pack/plugins/cases/common/api/cases/comment.ts", - "lineNumber": 67 - }, "signature": [ "TypeC", "<{ type: ", @@ -5850,18 +6471,20 @@ ".generatedAlert>, ", "LiteralC" ], + "source": { + "path": "x-pack/plugins/cases/common/api/cases/comment.ts", + "lineNumber": 67 + }, + "deprecated": false, "initialIsOpen": false }, { - "tags": [], + "parentPluginId": "cases", "id": "def-common.AllCommentsResponseRt", "type": "Object", + "tags": [], "label": "AllCommentsResponseRt", "description": [], - "source": { - "path": "x-pack/plugins/cases/common/api/cases/comment.ts", - "lineNumber": 128 - }, "signature": [ "ArrayC", "<", @@ -5873,18 +6496,20 @@ "<[", "TypeC" ], + "source": { + "path": "x-pack/plugins/cases/common/api/cases/comment.ts", + "lineNumber": 128 + }, + "deprecated": false, "initialIsOpen": false }, { - "tags": [], + "parentPluginId": "cases", "id": "def-common.AllCommentsResponseRT", "type": "Object", + "tags": [], "label": "AllCommentsResponseRT", "description": [], - "source": { - "path": "x-pack/plugins/cases/common/api/cases/comment.ts", - "lineNumber": 99 - }, "signature": [ "ArrayC", "<", @@ -5896,18 +6521,20 @@ "<[", "TypeC" ], + "source": { + "path": "x-pack/plugins/cases/common/api/cases/comment.ts", + "lineNumber": 99 + }, + "deprecated": false, "initialIsOpen": false }, { - "tags": [], + "parentPluginId": "cases", "id": "def-common.CaseAttributesRt", "type": "Object", + "tags": [], "label": "CaseAttributesRt", "description": [], - "source": { - "path": "x-pack/plugins/cases/common/api/cases/case.ts", - "lineNumber": 62 - }, "signature": [ "IntersectionC", "<[", @@ -5919,18 +6546,20 @@ "<[", "LiteralC" ], + "source": { + "path": "x-pack/plugins/cases/common/api/cases/case.ts", + "lineNumber": 62 + }, + "deprecated": false, "initialIsOpen": false }, { - "tags": [], + "parentPluginId": "cases", "id": "def-common.CaseConfigureAttributesRt", "type": "Object", + "tags": [], "label": "CaseConfigureAttributesRt", "description": [], - "source": { - "path": "x-pack/plugins/cases/common/api/cases/configure.ts", - "lineNumber": 27 - }, "signature": [ "IntersectionC", "<[", @@ -5942,18 +6571,20 @@ "<{ id: ", "StringC" ], + "source": { + "path": "x-pack/plugins/cases/common/api/cases/configure.ts", + "lineNumber": 27 + }, + "deprecated": false, "initialIsOpen": false }, { - "tags": [], + "parentPluginId": "cases", "id": "def-common.CaseConfigureResponseRt", "type": "Object", + "tags": [], "label": "CaseConfigureResponseRt", "description": [], - "source": { - "path": "x-pack/plugins/cases/common/api/cases/configure.ts", - "lineNumber": 37 - }, "signature": [ "IntersectionC", "<[", @@ -5965,18 +6596,20 @@ "<[", "TypeC" ], + "source": { + "path": "x-pack/plugins/cases/common/api/cases/configure.ts", + "lineNumber": 37 + }, + "deprecated": false, "initialIsOpen": false }, { - "tags": [], + "parentPluginId": "cases", "id": "def-common.CaseConnectorRt", "type": "Object", + "tags": [], "label": "CaseConnectorRt", "description": [], - "source": { - "path": "x-pack/plugins/cases/common/api/connectors/index.ts", - "lineNumber": 74 - }, "signature": [ "IntersectionC", "<[", @@ -5988,18 +6621,20 @@ "; }>, ", "UnionC" ], + "source": { + "path": "x-pack/plugins/cases/common/api/connectors/index.ts", + "lineNumber": 74 + }, + "deprecated": false, "initialIsOpen": false }, { - "tags": [], + "parentPluginId": "cases", "id": "def-common.CasePatchRequestRt", "type": "Object", + "tags": [], "label": "CasePatchRequestRt", "description": [], - "source": { - "path": "x-pack/plugins/cases/common/api/cases/case.ts", - "lineNumber": 142 - }, "signature": [ "IntersectionC", "<[", @@ -6011,20 +6646,22 @@ "<[", "LiteralC" ], + "source": { + "path": "x-pack/plugins/cases/common/api/cases/case.ts", + "lineNumber": 142 + }, + "deprecated": false, "initialIsOpen": false }, { - "tags": [], + "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." ], - "source": { - "path": "x-pack/plugins/cases/common/api/cases/case.ts", - "lineNumber": 97 - }, "signature": [ "IntersectionC", "<[", @@ -6042,18 +6679,20 @@ "text": "CaseType" } ], + "source": { + "path": "x-pack/plugins/cases/common/api/cases/case.ts", + "lineNumber": 97 + }, + "deprecated": false, "initialIsOpen": false }, { - "tags": [], + "parentPluginId": "cases", "id": "def-common.CasePushRequestParamsRt", "type": "Object", + "tags": [], "label": "CasePushRequestParamsRt", "description": [], - "source": { - "path": "x-pack/plugins/cases/common/api/cases/case.ts", - "lineNumber": 150 - }, "signature": [ "TypeC", "<{ case_id: ", @@ -6062,18 +6701,20 @@ "StringC", "; }>" ], + "source": { + "path": "x-pack/plugins/cases/common/api/cases/case.ts", + "lineNumber": 150 + }, + "deprecated": false, "initialIsOpen": false }, { - "tags": [], + "parentPluginId": "cases", "id": "def-common.CaseResponseRt", "type": "Object", + "tags": [], "label": "CaseResponseRt", "description": [], - "source": { - "path": "x-pack/plugins/cases/common/api/cases/case.ts", - "lineNumber": 117 - }, "signature": [ "IntersectionC", "<[", @@ -6085,20 +6726,22 @@ "; status: ", "UnionC" ], + "source": { + "path": "x-pack/plugins/cases/common/api/cases/case.ts", + "lineNumber": 117 + }, + "deprecated": false, "initialIsOpen": false }, { - "tags": [], + "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." ], - "source": { - "path": "x-pack/plugins/cases/common/api/cases/case.ts", - "lineNumber": 86 - }, "signature": [ "TypeC", "<{ type: ", @@ -6116,18 +6759,20 @@ ".collection>, ", "LiteralC" ], + "source": { + "path": "x-pack/plugins/cases/common/api/cases/case.ts", + "lineNumber": 86 + }, + "deprecated": false, "initialIsOpen": false }, { - "tags": [], + "parentPluginId": "cases", "id": "def-common.CasesConfigurePatchRt", "type": "Object", + "tags": [], "label": "CasesConfigurePatchRt", "description": [], - "source": { - "path": "x-pack/plugins/cases/common/api/cases/configure.ts", - "lineNumber": 22 - }, "signature": [ "IntersectionC", "<[", @@ -6139,18 +6784,20 @@ "<{ id: ", "StringC" ], + "source": { + "path": "x-pack/plugins/cases/common/api/cases/configure.ts", + "lineNumber": 22 + }, + "deprecated": false, "initialIsOpen": false }, { - "tags": [], + "parentPluginId": "cases", "id": "def-common.CasesConfigureRequestRt", "type": "Object", + "tags": [], "label": "CasesConfigureRequestRt", "description": [], - "source": { - "path": "x-pack/plugins/cases/common/api/cases/configure.ts", - "lineNumber": 21 - }, "signature": [ "TypeC", "<{ connector: ", @@ -6162,18 +6809,20 @@ "; name: ", "StringC" ], + "source": { + "path": "x-pack/plugins/cases/common/api/cases/configure.ts", + "lineNumber": 21 + }, + "deprecated": false, "initialIsOpen": false }, { - "tags": [], + "parentPluginId": "cases", "id": "def-common.CasesFindRequestRt", "type": "Object", + "tags": [], "label": "CasesFindRequestRt", "description": [], - "source": { - "path": "x-pack/plugins/cases/common/api/cases/case.ts", - "lineNumber": 102 - }, "signature": [ "PartialC", "<{ type: ", @@ -6191,18 +6840,20 @@ ".collection>, ", "LiteralC" ], + "source": { + "path": "x-pack/plugins/cases/common/api/cases/case.ts", + "lineNumber": 102 + }, + "deprecated": false, "initialIsOpen": false }, { - "tags": [], + "parentPluginId": "cases", "id": "def-common.CasesFindResponseRt", "type": "Object", + "tags": [], "label": "CasesFindResponseRt", "description": [], - "source": { - "path": "x-pack/plugins/cases/common/api/cases/case.ts", - "lineNumber": 132 - }, "signature": [ "IntersectionC", "<[", @@ -6214,18 +6865,20 @@ "<[", "IntersectionC" ], + "source": { + "path": "x-pack/plugins/cases/common/api/cases/case.ts", + "lineNumber": 132 + }, + "deprecated": false, "initialIsOpen": false }, { - "tags": [], + "parentPluginId": "cases", "id": "def-common.CasesPatchRequestRt", "type": "Object", + "tags": [], "label": "CasesPatchRequestRt", "description": [], - "source": { - "path": "x-pack/plugins/cases/common/api/cases/case.ts", - "lineNumber": 147 - }, "signature": [ "TypeC", "<{ cases: ", @@ -6237,18 +6890,20 @@ "<{ description: ", "StringC" ], + "source": { + "path": "x-pack/plugins/cases/common/api/cases/case.ts", + "lineNumber": 147 + }, + "deprecated": false, "initialIsOpen": false }, { - "tags": [], + "parentPluginId": "cases", "id": "def-common.CasesResponseRt", "type": "Object", + "tags": [], "label": "CasesResponseRt", "description": [], - "source": { - "path": "x-pack/plugins/cases/common/api/cases/case.ts", - "lineNumber": 148 - }, "signature": [ "ArrayC", "<", @@ -6260,18 +6915,20 @@ "<{ description: ", "StringC" ], + "source": { + "path": "x-pack/plugins/cases/common/api/cases/case.ts", + "lineNumber": 148 + }, + "deprecated": false, "initialIsOpen": false }, { - "tags": [], + "parentPluginId": "cases", "id": "def-common.CasesStatusResponseRt", "type": "Object", + "tags": [], "label": "CasesStatusResponseRt", "description": [], - "source": { - "path": "x-pack/plugins/cases/common/api/cases/status.ts", - "lineNumber": 24 - }, "signature": [ "TypeC", "<{ count_open_cases: ", @@ -6282,18 +6939,20 @@ "NumberC", "; }>" ], + "source": { + "path": "x-pack/plugins/cases/common/api/cases/status.ts", + "lineNumber": 24 + }, + "deprecated": false, "initialIsOpen": false }, { - "tags": [], + "parentPluginId": "cases", "id": "def-common.CaseStatusRt", "type": "Object", + "tags": [], "label": "CaseStatusRt", "description": [], - "source": { - "path": "x-pack/plugins/cases/common/api/cases/status.ts", - "lineNumber": 16 - }, "signature": [ "UnionC", "<[", @@ -6317,18 +6976,20 @@ "text": "CaseStatuses" } ], + "source": { + "path": "x-pack/plugins/cases/common/api/cases/status.ts", + "lineNumber": 16 + }, + "deprecated": false, "initialIsOpen": false }, { - "tags": [], + "parentPluginId": "cases", "id": "def-common.CaseUserActionAttributesRt", "type": "Object", + "tags": [], "label": "CaseUserActionAttributesRt", "description": [], - "source": { - "path": "x-pack/plugins/cases/common/api/cases/user_actions.ts", - "lineNumber": 55 - }, "signature": [ "TypeC", "<{ action_field: ", @@ -6340,18 +7001,20 @@ "<\"comment\">, ", "LiteralC" ], + "source": { + "path": "x-pack/plugins/cases/common/api/cases/user_actions.ts", + "lineNumber": 55 + }, + "deprecated": false, "initialIsOpen": false }, { - "tags": [], + "parentPluginId": "cases", "id": "def-common.CaseUserActionsResponseRt", "type": "Object", + "tags": [], "label": "CaseUserActionsResponseRt", "description": [], - "source": { - "path": "x-pack/plugins/cases/common/api/cases/user_actions.ts", - "lineNumber": 57 - }, "signature": [ "ArrayC", "<", @@ -6363,18 +7026,20 @@ "<", "UnionC" ], + "source": { + "path": "x-pack/plugins/cases/common/api/cases/user_actions.ts", + "lineNumber": 57 + }, + "deprecated": false, "initialIsOpen": false }, { - "tags": [], + "parentPluginId": "cases", "id": "def-common.CommentAttributesBasicRt", "type": "Object", + "tags": [], "label": "CommentAttributesBasicRt", "description": [], - "source": { - "path": "x-pack/plugins/cases/common/api/cases/comment.ts", - "lineNumber": 38 - }, "signature": [ "TypeC", "<{ associationType: ", @@ -6392,20 +7057,22 @@ ".case>, ", "LiteralC" ], + "source": { + "path": "x-pack/plugins/cases/common/api/cases/comment.ts", + "lineNumber": 38 + }, + "deprecated": false, "initialIsOpen": false }, { - "tags": [], + "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." ], - "source": { - "path": "x-pack/plugins/cases/common/api/cases/comment.ts", - "lineNumber": 116 - }, "signature": [ "IntersectionC", "<[", @@ -6417,18 +7084,20 @@ "<[", "LiteralC" ], + "source": { + "path": "x-pack/plugins/cases/common/api/cases/comment.ts", + "lineNumber": 116 + }, + "deprecated": false, "initialIsOpen": false }, { - "tags": [], + "parentPluginId": "cases", "id": "def-common.CommentPatchRequestRt", "type": "Object", + "tags": [], "label": "CommentPatchRequestRt", "description": [], - "source": { - "path": "x-pack/plugins/cases/common/api/cases/comment.ts", - "lineNumber": 101 - }, "signature": [ "IntersectionC", "<[", @@ -6440,18 +7109,20 @@ "; type: ", "LiteralC" ], + "source": { + "path": "x-pack/plugins/cases/common/api/cases/comment.ts", + "lineNumber": 101 + }, + "deprecated": false, "initialIsOpen": false }, { - "tags": [], + "parentPluginId": "cases", "id": "def-common.CommentRequestRt", "type": "Object", - "label": "CommentRequestRt", - "description": [], - "source": { - "path": "x-pack/plugins/cases/common/api/cases/comment.ts", - "lineNumber": 81 - }, + "tags": [], + "label": "CommentRequestRt", + "description": [], "signature": [ "UnionC", "<[", @@ -6469,18 +7140,20 @@ "text": "CommentType" } ], + "source": { + "path": "x-pack/plugins/cases/common/api/cases/comment.ts", + "lineNumber": 81 + }, + "deprecated": false, "initialIsOpen": false }, { - "tags": [], + "parentPluginId": "cases", "id": "def-common.CommentResponseRt", "type": "Object", + "tags": [], "label": "CommentResponseRt", "description": [], - "source": { - "path": "x-pack/plugins/cases/common/api/cases/comment.ts", - "lineNumber": 83 - }, "signature": [ "IntersectionC", "<[", @@ -6492,18 +7165,20 @@ "<{ comment: ", "StringC" ], + "source": { + "path": "x-pack/plugins/cases/common/api/cases/comment.ts", + "lineNumber": 83 + }, + "deprecated": false, "initialIsOpen": false }, { - "tags": [], + "parentPluginId": "cases", "id": "def-common.CommentResponseTypeAlertsRt", "type": "Object", + "tags": [], "label": "CommentResponseTypeAlertsRt", "description": [], - "source": { - "path": "x-pack/plugins/cases/common/api/cases/comment.ts", - "lineNumber": 91 - }, "signature": [ "IntersectionC", "<[", @@ -6515,18 +7190,20 @@ "<[", "LiteralC" ], + "source": { + "path": "x-pack/plugins/cases/common/api/cases/comment.ts", + "lineNumber": 91 + }, + "deprecated": false, "initialIsOpen": false }, { - "tags": [], + "parentPluginId": "cases", "id": "def-common.CommentsResponseRt", "type": "Object", + "tags": [], "label": "CommentsResponseRt", "description": [], - "source": { - "path": "x-pack/plugins/cases/common/api/cases/comment.ts", - "lineNumber": 121 - }, "signature": [ "TypeC", "<{ comments: ", @@ -6538,18 +7215,20 @@ "<[", "IntersectionC" ], + "source": { + "path": "x-pack/plugins/cases/common/api/cases/comment.ts", + "lineNumber": 121 + }, + "deprecated": false, "initialIsOpen": false }, { - "tags": [], + "parentPluginId": "cases", "id": "def-common.ConnectorFieldsRt", "type": "Object", + "tags": [], "label": "ConnectorFieldsRt", "description": [], - "source": { - "path": "x-pack/plugins/cases/common/api/connectors/index.ts", - "lineNumber": 25 - }, "signature": [ "UnionC", "<[", @@ -6561,18 +7240,20 @@ ", ", "NullC" ], + "source": { + "path": "x-pack/plugins/cases/common/api/connectors/index.ts", + "lineNumber": 25 + }, + "deprecated": false, "initialIsOpen": false }, { - "tags": [], + "parentPluginId": "cases", "id": "def-common.ConnectorMappingsAttributesRT", "type": "Object", + "tags": [], "label": "ConnectorMappingsAttributesRT", "description": [], - "source": { - "path": "x-pack/plugins/cases/common/api/connectors/mappings.ts", - "lineNumber": 26 - }, "signature": [ "TypeC", "<{ action_type: ", @@ -6584,18 +7265,20 @@ "<\"nothing\">, ", "LiteralC" ], + "source": { + "path": "x-pack/plugins/cases/common/api/connectors/mappings.ts", + "lineNumber": 26 + }, + "deprecated": false, "initialIsOpen": false }, { - "tags": [], + "parentPluginId": "cases", "id": "def-common.ConnectorMappingsRt", "type": "Object", + "tags": [], "label": "ConnectorMappingsRt", "description": [], - "source": { - "path": "x-pack/plugins/cases/common/api/connectors/mappings.ts", - "lineNumber": 32 - }, "signature": [ "TypeC", "<{ mappings: ", @@ -6607,18 +7290,20 @@ "<[", "LiteralC" ], + "source": { + "path": "x-pack/plugins/cases/common/api/connectors/mappings.ts", + "lineNumber": 32 + }, + "deprecated": false, "initialIsOpen": false }, { - "tags": [], + "parentPluginId": "cases", "id": "def-common.ConnectorTypeFieldsRt", "type": "Object", + "tags": [], "label": "ConnectorTypeFieldsRt", "description": [], - "source": { - "path": "x-pack/plugins/cases/common/api/connectors/index.ts", - "lineNumber": 66 - }, "signature": [ "UnionC", "<[", @@ -6636,18 +7321,20 @@ ".jira>; fields: ", "UnionC" ], + "source": { + "path": "x-pack/plugins/cases/common/api/connectors/index.ts", + "lineNumber": 66 + }, + "deprecated": false, "initialIsOpen": false }, { - "tags": [], + "parentPluginId": "cases", "id": "def-common.ContextTypeUserRt", "type": "Object", + "tags": [], "label": "ContextTypeUserRt", "description": [], - "source": { - "path": "x-pack/plugins/cases/common/api/cases/comment.ts", - "lineNumber": 57 - }, "signature": [ "TypeC", "<{ comment: ", @@ -6664,18 +7351,20 @@ }, ".user>; }>" ], + "source": { + "path": "x-pack/plugins/cases/common/api/cases/comment.ts", + "lineNumber": 57 + }, + "deprecated": false, "initialIsOpen": false }, { - "tags": [], + "parentPluginId": "cases", "id": "def-common.ExternalServiceResponseRt", "type": "Object", + "tags": [], "label": "ExternalServiceResponseRt", "description": [], - "source": { - "path": "x-pack/plugins/cases/common/api/cases/case.ts", - "lineNumber": 155 - }, "signature": [ "IntersectionC", "<[", @@ -6687,18 +7376,20 @@ "; pushedDate: ", "StringC" ], + "source": { + "path": "x-pack/plugins/cases/common/api/cases/case.ts", + "lineNumber": 155 + }, + "deprecated": false, "initialIsOpen": false }, { - "tags": [], + "parentPluginId": "cases", "id": "def-common.GetCaseIdsByAlertIdAggsRt", "type": "Object", + "tags": [], "label": "GetCaseIdsByAlertIdAggsRt", "description": [], - "source": { - "path": "x-pack/plugins/cases/common/api/cases/comment.ts", - "lineNumber": 18 - }, "signature": [ "TypeC", "<{ references: ", @@ -6710,18 +7401,20 @@ "<{ buckets: ", "ArrayC" ], + "source": { + "path": "x-pack/plugins/cases/common/api/cases/comment.ts", + "lineNumber": 18 + }, + "deprecated": false, "initialIsOpen": false }, { - "tags": [], + "parentPluginId": "cases", "id": "def-common.JiraFieldsRT", "type": "Object", + "tags": [], "label": "JiraFieldsRT", "description": [], - "source": { - "path": "x-pack/plugins/cases/common/api/connectors/jira.ts", - "lineNumber": 11 - }, "signature": [ "TypeC", "<{ issueType: ", @@ -6733,34 +7426,38 @@ "]>; priority: ", "UnionC" ], + "source": { + "path": "x-pack/plugins/cases/common/api/connectors/jira.ts", + "lineNumber": 11 + }, + "deprecated": false, "initialIsOpen": false }, { - "tags": [], + "parentPluginId": "cases", "id": "def-common.NumberFromString", "type": "Object", + "tags": [], "label": "NumberFromString", "description": [], - "source": { - "path": "x-pack/plugins/cases/common/api/saved_object.ts", - "lineNumber": 12 - }, "signature": [ "Type", "" ], + "source": { + "path": "x-pack/plugins/cases/common/api/saved_object.ts", + "lineNumber": 12 + }, + "deprecated": false, "initialIsOpen": false }, { - "tags": [], + "parentPluginId": "cases", "id": "def-common.ResilientFieldsRT", "type": "Object", + "tags": [], "label": "ResilientFieldsRT", "description": [], - "source": { - "path": "x-pack/plugins/cases/common/api/connectors/resilient.ts", - "lineNumber": 11 - }, "signature": [ "TypeC", "<{ incidentTypes: ", @@ -6772,18 +7469,20 @@ ">, ", "NullC" ], + "source": { + "path": "x-pack/plugins/cases/common/api/connectors/resilient.ts", + "lineNumber": 11 + }, + "deprecated": false, "initialIsOpen": false }, { - "tags": [], + "parentPluginId": "cases", "id": "def-common.SavedObjectFindOptionsRt", "type": "Object", + "tags": [], "label": "SavedObjectFindOptionsRt", "description": [], - "source": { - "path": "x-pack/plugins/cases/common/api/saved_object.ts", - "lineNumber": 25 - }, "signature": [ "PartialC", "<{ defaultSearchOperator: ", @@ -6795,18 +7494,20 @@ "<\"OR\">]>; hasReferenceOperator: ", "UnionC" ], + "source": { + "path": "x-pack/plugins/cases/common/api/saved_object.ts", + "lineNumber": 25 + }, + "deprecated": false, "initialIsOpen": false }, { - "tags": [], + "parentPluginId": "cases", "id": "def-common.ServiceNowITSMFieldsRT", "type": "Object", + "tags": [], "label": "ServiceNowITSMFieldsRT", "description": [], - "source": { - "path": "x-pack/plugins/cases/common/api/connectors/servicenow_itsm.ts", - "lineNumber": 11 - }, "signature": [ "TypeC", "<{ impact: ", @@ -6818,18 +7519,20 @@ "]>; severity: ", "UnionC" ], + "source": { + "path": "x-pack/plugins/cases/common/api/connectors/servicenow_itsm.ts", + "lineNumber": 11 + }, + "deprecated": false, "initialIsOpen": false }, { - "tags": [], + "parentPluginId": "cases", "id": "def-common.ServiceNowSIRFieldsRT", "type": "Object", + "tags": [], "label": "ServiceNowSIRFieldsRT", "description": [], - "source": { - "path": "x-pack/plugins/cases/common/api/connectors/servicenow_sir.ts", - "lineNumber": 11 - }, "signature": [ "TypeC", "<{ category: ", @@ -6841,18 +7544,20 @@ "]>; destIp: ", "UnionC" ], + "source": { + "path": "x-pack/plugins/cases/common/api/connectors/servicenow_sir.ts", + "lineNumber": 11 + }, + "deprecated": false, "initialIsOpen": false }, { - "tags": [], + "parentPluginId": "cases", "id": "def-common.SubCaseAttributesRt", "type": "Object", + "tags": [], "label": "SubCaseAttributesRt", "description": [], - "source": { - "path": "x-pack/plugins/cases/common/api/cases/sub_case.ts", - "lineNumber": 20 - }, "signature": [ "IntersectionC", "<[", @@ -6870,18 +7575,20 @@ "text": "CaseStatuses" } ], + "source": { + "path": "x-pack/plugins/cases/common/api/cases/sub_case.ts", + "lineNumber": 20 + }, + "deprecated": false, "initialIsOpen": false }, { - "tags": [], + "parentPluginId": "cases", "id": "def-common.SubCasePatchRequestRt", "type": "Object", + "tags": [], "label": "SubCasePatchRequestRt", "description": [], - "source": { - "path": "x-pack/plugins/cases/common/api/cases/sub_case.ts", - "lineNumber": 67 - }, "signature": [ "IntersectionC", "<[", @@ -6899,18 +7606,20 @@ "text": "CaseStatuses" } ], + "source": { + "path": "x-pack/plugins/cases/common/api/cases/sub_case.ts", + "lineNumber": 67 + }, + "deprecated": false, "initialIsOpen": false }, { - "tags": [], + "parentPluginId": "cases", "id": "def-common.SubCaseResponseRt", "type": "Object", + "tags": [], "label": "SubCaseResponseRt", "description": [], - "source": { - "path": "x-pack/plugins/cases/common/api/cases/sub_case.ts", - "lineNumber": 44 - }, "signature": [ "IntersectionC", "<[", @@ -6922,18 +7631,20 @@ "<[", "LiteralC" ], + "source": { + "path": "x-pack/plugins/cases/common/api/cases/sub_case.ts", + "lineNumber": 44 + }, + "deprecated": false, "initialIsOpen": false }, { - "tags": [], + "parentPluginId": "cases", "id": "def-common.SubCasesFindRequestRt", "type": "Object", + "tags": [], "label": "SubCasesFindRequestRt", "description": [], - "source": { - "path": "x-pack/plugins/cases/common/api/cases/sub_case.ts", - "lineNumber": 32 - }, "signature": [ "PartialC", "<{ status: ", @@ -6951,18 +7662,20 @@ ".open>, ", "LiteralC" ], + "source": { + "path": "x-pack/plugins/cases/common/api/cases/sub_case.ts", + "lineNumber": 32 + }, + "deprecated": false, "initialIsOpen": false }, { - "tags": [], + "parentPluginId": "cases", "id": "def-common.SubCasesFindResponseRt", "type": "Object", + "tags": [], "label": "SubCasesFindResponseRt", "description": [], - "source": { - "path": "x-pack/plugins/cases/common/api/cases/sub_case.ts", - "lineNumber": 57 - }, "signature": [ "IntersectionC", "<[", @@ -6974,18 +7687,20 @@ "<[", "IntersectionC" ], + "source": { + "path": "x-pack/plugins/cases/common/api/cases/sub_case.ts", + "lineNumber": 57 + }, + "deprecated": false, "initialIsOpen": false }, { - "tags": [], + "parentPluginId": "cases", "id": "def-common.SubCasesPatchRequestRt", "type": "Object", + "tags": [], "label": "SubCasesPatchRequestRt", "description": [], - "source": { - "path": "x-pack/plugins/cases/common/api/cases/sub_case.ts", - "lineNumber": 72 - }, "signature": [ "TypeC", "<{ subCases: ", @@ -6997,18 +7712,20 @@ "<{ status: ", "UnionC" ], + "source": { + "path": "x-pack/plugins/cases/common/api/cases/sub_case.ts", + "lineNumber": 72 + }, + "deprecated": false, "initialIsOpen": false }, { - "tags": [], + "parentPluginId": "cases", "id": "def-common.SubCasesResponseRt", "type": "Object", + "tags": [], "label": "SubCasesResponseRt", "description": [], - "source": { - "path": "x-pack/plugins/cases/common/api/cases/sub_case.ts", - "lineNumber": 73 - }, "signature": [ "ArrayC", "<", @@ -7020,18 +7737,20 @@ "<{ status: ", "UnionC" ], + "source": { + "path": "x-pack/plugins/cases/common/api/cases/sub_case.ts", + "lineNumber": 73 + }, + "deprecated": false, "initialIsOpen": false }, { - "tags": [], + "parentPluginId": "cases", "id": "def-common.UserRT", "type": "Object", + "tags": [], "label": "UserRT", "description": [], - "source": { - "path": "x-pack/plugins/cases/common/api/user.ts", - "lineNumber": 10 - }, "signature": [ "TypeC", "<{ email: ", @@ -7043,18 +7762,20 @@ ", ", "StringC" ], + "source": { + "path": "x-pack/plugins/cases/common/api/user.ts", + "lineNumber": 10 + }, + "deprecated": false, "initialIsOpen": false }, { - "tags": [], + "parentPluginId": "cases", "id": "def-common.UsersRt", "type": "Object", + "tags": [], "label": "UsersRt", "description": [], - "source": { - "path": "x-pack/plugins/cases/common/api/user.ts", - "lineNumber": 16 - }, "signature": [ "ArrayC", "<", @@ -7066,6 +7787,11 @@ ", ", "NullC" ], + "source": { + "path": "x-pack/plugins/cases/common/api/user.ts", + "lineNumber": 16 + }, + "deprecated": false, "initialIsOpen": false } ] 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 cb20e5640d1d1..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": 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": 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": 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": 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": 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": 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": 42 - } + }, + "deprecated": false } ], - "source": { - "path": "x-pack/plugins/cloud/public/plugin.ts", - "lineNumber": 35 - }, "lifecycle": "setup", "initialIsOpen": true } @@ -225,70 +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": 20 }, - "signature": [ - "string | undefined" - ] + "deprecated": false }, { - "tags": [], + "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 }, - "signature": [ - "string | undefined" - ] + "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": 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": 23 }, - "signature": [ - "{ url?: string | undefined; secretToken?: string | undefined; }" - ] + "deprecated": false } ], - "source": { - "path": "x-pack/plugins/cloud/server/plugin.ts", - "lineNumber": 19 - }, "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 dd84c72be0c2a..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": 215 - }, "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": 217 - }, "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": 219 - }, "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": 221 - }, "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": 223 - }, "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": 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": 234 - }, "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": 213 - }, "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": 260 - }, "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": 262 - }, "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": 264 - }, "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": 266 - }, "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": 268 - }, "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": 270 - }, "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": 272 - }, "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": 274 - }, "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": 276 - }, "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": 278 - }, "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": 280 - }, "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": 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": 258 - }, "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,71 +1692,81 @@ "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": 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": 409 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-public.DocLinksStart.links", "type": "Object", + "tags": [], "label": "links", "description": [], - "source": { - "path": "src/core/public/doc_links/doc_links_service.ts", - "lineNumber": 410 - }, "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": 410 + }, + "deprecated": false } ], - "source": { - "path": "src/core/public/doc_links/doc_links_service.ts", - "lineNumber": 407 - }, "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-public.DomainDeprecationDetails", "type": "Interface", + "tags": [], "label": "DomainDeprecationDetails", + "description": [], "signature": [ "DomainDeprecationDetails", " extends ", @@ -1617,86 +1778,98 @@ "text": "DeprecationsDetails" } ], - "description": [], - "tags": [], + "source": { + "path": "src/core/server/deprecations/types.ts", + "lineNumber": 14 + }, + "deprecated": false, "children": [ { - "tags": [], + "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 } ], - "source": { - "path": "src/core/server/deprecations/types.ts", - "lineNumber": 14 - }, "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", @@ -1714,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." @@ -1732,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", @@ -1851,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." @@ -1916,302 +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": [], + "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": 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": 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": 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": 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": 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": 90 - }, "signature": [ "() => ", "Observable", "<{ key: string; newValue: T; oldValue: T; }>" - ] + ], + "source": { + "path": "src/core/public/ui_settings/types.ts", + "lineNumber": 90 + }, + "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": 100 - }, "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<", { @@ -2222,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<", { @@ -2262,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: ", { @@ -2295,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", @@ -2314,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: ", { @@ -2398,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", @@ -2433,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: ", { @@ -2629,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", @@ -2648,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", @@ -2669,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: ", { @@ -2949,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", @@ -2968,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", @@ -2989,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 | ", { @@ -3028,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 | ", { @@ -3048,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", @@ -3069,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", @@ -3171,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: ", { @@ -3210,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: ", { @@ -3249,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 | ", { @@ -3281,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", @@ -3378,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: ", { @@ -3400,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", @@ -3417,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: ", { @@ -3460,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", @@ -3476,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", @@ -3541,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`" @@ -3625,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." @@ -3638,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": 164 }, - "signature": [ - "string | undefined" - ] + "deprecated": false } ], - "source": { - "path": "src/core/server/saved_objects/types.ts", - "lineNumber": 162 - }, "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", @@ -4160,132 +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 }, - "signature": [ - "any" - ] + "deprecated": false }, { + "parentPluginId": "core", + "id": "def-public.SavedObjectsFindOptions.aggs", + "type": "Object", "tags": [ "alpha" ], - "id": "def-public.SavedObjectsFindOptions.aggs", - "type": "Object", "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" ], - "source": { - "path": "src/core/server/saved_objects/types.ts", - "lineNumber": 140 - }, "signature": [ "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": 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": 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": 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": 155 - }, "signature": [ { "pluginId": "core", @@ -4295,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." @@ -4378,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." @@ -4391,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", @@ -4637,104 +5101,114 @@ "section": "def-server.SavedObjectsImportUnknownError", "text": "SavedObjectsImportUnknownError" } - ] - } - ], - "source": { - "path": "src/core/server/saved_objects/import/types.ts", - "lineNumber": 89 - }, + ], + "source": { + "path": "src/core/server/saved_objects/import/types.ts", + "lineNumber": 101 + }, + "deprecated": false + } + ], "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", @@ -4744,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", @@ -4765,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", @@ -4786,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" @@ -4944,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", " | ", @@ -5515,204 +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": [], + "signature": [ + "Type", + "" + ], "source": { "path": "src/core/types/ui_settings.ts", "lineNumber": 86 }, - "signature": [ - "Type", - "" - ] + "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" - ], - "children": [ + "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": [ { - "tags": [ - "public" - ], + "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 }, - "signature": [ - "\"kbnAppWrapper\"" - ], + "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) => ", { @@ -5723,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: ", { @@ -5766,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": [], + "signature": [ + "symbol" + ], "source": { "path": "src/core/server/plugins/types.ts", "lineNumber": 117 }, - "signature": [ - "symbol" - ], + "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", @@ -5840,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", @@ -5893,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" ], + "signature": [ + "\"multiple\" | \"single\" | \"multiple-isolated\" | \"agnostic\"" + ], "source": { "path": "src/core/server/saved_objects/types.ts", "lineNumber": 249 }, - "signature": [ - "\"multiple\" | \"single\" | \"multiple-isolated\" | \"agnostic\"" - ], + "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": 244 - }, "signature": [ "() => Promise<[", { @@ -5939,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 | ", { @@ -6001,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", @@ -6072,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", @@ -6124,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 } ], @@ -6189,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." @@ -6215,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": 53 - }, "signature": [ { "pluginId": "core", @@ -6234,104 +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": 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": 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": 57 - } + }, + "deprecated": false }, { - "tags": [], + "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 }, { - "tags": [], + "parentPluginId": "core", "id": "def-server.CspConfig.header", "type": "string", + "tags": [], "label": "header", "description": [], "source": { "path": "src/core/server/csp/csp_config.ts", "lineNumber": 59 - } + }, + "deprecated": false } ], - "source": { - "path": "src/core/server/csp/csp_config.ts", - "lineNumber": 52 - }, "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." @@ -6339,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." @@ -6352,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." @@ -6445,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." @@ -6474,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": [ @@ -6607,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", @@ -6631,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", @@ -6679,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", - "children": [ + "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?: ", { - "id": "def-server.LegacyClusterClient.callAsInternalUser.$1", - "type": "string", - "label": "endpoint", - "isRequired": true, - "signature": [ - "string" - ], - "description": [], - "source": { - "path": "src/core/server/elasticsearch/legacy/cluster_client.ts", - "lineNumber": 141 + "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", + "description": [], + "signature": [ + "string" + ], + "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", @@ -6740,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?: ", { @@ -6828,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", @@ -6863,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 ", { @@ -6912,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 ", { @@ -6951,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": [ @@ -7025,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", @@ -7049,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", @@ -7069,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", @@ -7090,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?: ", { @@ -7119,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", @@ -7170,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?: ", { @@ -7203,5605 +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": 307 + "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": 307 + "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": 307 - } - }, - { - "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": 309 + "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": 309 + "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": 309 - } - }, - { - "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": 311 - } - } - ], - "source": { - "path": "src/core/server/plugins/types.ts", - "lineNumber": 301 - }, - "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" - } - ], - "description": [ - "\nCreates a new {@link IContextContainer} for a service owner." - ], - "children": [], - "tags": [], - "returnComment": [], - "source": { - "path": "src/core/server/context/context_service.ts", - "lineNumber": 96 - } - } - ], - "source": { - "path": "src/core/server/context/context_service.ts", - "lineNumber": 92 - }, - "initialIsOpen": false - }, - { - "id": "def-server.CoreSetup", - "type": "Interface", - "label": "CoreSetup", - "signature": [ - { - "pluginId": "core", + "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" + ], + "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.CoreSetup", - "text": "CoreSetup" + "section": "def-server.DeprecationAPIClientParams", + "text": "DeprecationAPIClientParams" }, - "" + " extends ", + "GenericParams" ], - "description": [ - "\nContext passed to the plugins `setup` method.\n" + "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\"" + ], + "source": { + "path": "src/core/server/elasticsearch/legacy/api_types.ts", + "lineNumber": 350 + }, + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.DeprecationAPIClientParams.method", + "type": "string", + "tags": [], + "label": "method", + "description": [], + "signature": [ + "\"GET\"" + ], + "source": { + "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/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": [ - "public" + "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": [], - "id": "def-server.CoreSetup.capabilities", + "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 + }, + { + "parentPluginId": "core", + "id": "def-server.DeprecationsDetails", + "type": "Interface", + "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": [], + "label": "message", + "description": [], + "source": { + "path": "src/core/server/deprecations/types.ts", + "lineNumber": 20 + }, + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.DeprecationsDetails.level", + "type": "CompoundType", + "tags": [], + "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." + ], + "signature": [ + "\"warning\" | \"critical\" | \"fetch_error\"" + ], + "source": { + "path": "src/core/server/deprecations/types.ts", + "lineNumber": 27 + }, + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.DeprecationsDetails.documentationUrl", + "type": "string", + "tags": [], + "label": "documentationUrl", + "description": [], + "signature": [ + "string | undefined" + ], + "source": { + "path": "src/core/server/deprecations/types.ts", + "lineNumber": 29 + }, + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.DeprecationsDetails.correctiveActions", "type": "Object", - "label": "capabilities", + "tags": [], + "label": "correctiveActions", + "description": [], + "signature": [ + "{ api?: { path: string; method: \"POST\" | \"PUT\"; body?: { [key: string]: any; } | undefined; } | undefined; manualSteps?: string[] | undefined; }" + ], + "source": { + "path": "src/core/server/deprecations/types.ts", + "lineNumber": 31 + }, + "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": [], + "label": "message", "description": [ - "{@link CapabilitiesSetup}" + "Deprecation message" ], "source": { - "path": "src/core/server/index.ts", - "lineNumber": 474 + "path": "src/core/types/ui_settings.ts", + "lineNumber": 34 + }, + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.DeprecationSettings.docLinksKey", + "type": "string", + "tags": [], + "label": "docLinksKey", + "description": [ + "Key to documentation links" + ], + "source": { + "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.CapabilitiesSetup", - "text": "CapabilitiesSetup" - } - ] - }, + "section": "def-server.RegisterDeprecationsConfig", + "text": "RegisterDeprecationsConfig" + }, + ") => void" + ], + "source": { + "path": "src/core/server/deprecations/deprecations_service.ts", + "lineNumber": 104 + }, + "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": [ { - "tags": [], - "id": "def-server.CoreSetup.context", - "type": "Object", - "label": "context", + "parentPluginId": "core", + "id": "def-server.DiscoveredPlugin.id", + "type": "string", + "tags": [], + "label": "id", "description": [ - "{@link ContextSetup}" + "\nIdentifier of the plugin." ], "source": { - "path": "src/core/server/index.ts", - "lineNumber": 476 + "path": "src/core/server/plugins/types.ts", + "lineNumber": 222 }, - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.ContextSetup", - "text": "ContextSetup" - } - ] + "deprecated": false }, { + "parentPluginId": "core", + "id": "def-server.DiscoveredPlugin.configPath", + "type": "CompoundType", "tags": [], - "id": "def-server.CoreSetup.elasticsearch", - "type": "Object", - "label": "elasticsearch", + "label": "configPath", "description": [ - "{@link ElasticsearchServiceSetup}" + "\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": 478 + "path": "src/core/server/plugins/types.ts", + "lineNumber": 227 }, - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.ElasticsearchServiceSetup", - "text": "ElasticsearchServiceSetup" - } - ] + "deprecated": false }, { + "parentPluginId": "core", + "id": "def-server.DiscoveredPlugin.requiredPlugins", + "type": "Object", "tags": [], - "id": "def-server.CoreSetup.http", - "type": "CompoundType", - "label": "http", + "label": "requiredPlugins", "description": [ - "{@link HttpServiceSetup}" + "\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": 480 + "path": "src/core/server/plugins/types.ts", + "lineNumber": 233 }, - "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 }, { - "tags": [], - "id": "def-server.CoreSetup.i18n", + "parentPluginId": "core", + "id": "def-server.DiscoveredPlugin.optionalPlugins", "type": "Object", - "label": "i18n", + "tags": [], + "label": "optionalPlugins", "description": [ - "{@link I18nServiceSetup}" + "\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": 485 + "path": "src/core/server/plugins/types.ts", + "lineNumber": 240 }, - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.I18nServiceSetup", - "text": "I18nServiceSetup" - } - ] + "deprecated": false }, { - "tags": [], - "id": "def-server.CoreSetup.logging", + "parentPluginId": "core", + "id": "def-server.DiscoveredPlugin.requiredBundles", "type": "Object", - "label": "logging", + "tags": [], + "label": "requiredBundles", "description": [ - "{@link LoggingServiceSetup}" + "\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": 487 + "path": "src/core/server/plugins/types.ts", + "lineNumber": 252 }, + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-server.ElasticsearchServiceSetup", + "type": "Interface", + "tags": [], + "label": "ElasticsearchServiceSetup", + "description": [], + "source": { + "path": "src/core/server/elasticsearch/types.ts", + "lineNumber": 25 + }, + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.ElasticsearchServiceSetup.legacy", + "type": "Object", + "tags": [ + "deprecated" + ], + "label": "legacy", + "description": [], "signature": [ + "{ readonly config$: ", + "Observable", + "<", { "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}" - ], - "source": { - "path": "src/core/server/index.ts", - "lineNumber": 489 - }, - "signature": [ + "section": "def-server.ElasticsearchConfig", + "text": "ElasticsearchConfig" + }, + ">; readonly createClient: (type: string, clientConfig?: Partial<", { "pluginId": "core", "scope": "server", "docId": "kibCorePluginApi", - "section": "def-server.MetricsServiceSetup", - "text": "MetricsServiceSetup" - } - ] - }, - { - "tags": [], - "id": "def-server.CoreSetup.savedObjects", - "type": "Object", - "label": "savedObjects", - "description": [ - "{@link SavedObjectsServiceSetup}" - ], - "source": { - "path": "src/core/server/index.ts", - "lineNumber": 491 - }, - "signature": [ + "section": "def-server.LegacyElasticsearchClientConfig", + "text": "LegacyElasticsearchClientConfig" + }, + "> | undefined) => Pick<", { "pluginId": "core", "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsServiceSetup", - "text": "SavedObjectsServiceSetup" + "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.CoreSetup.status", - "type": "Object", - "label": "status", - "description": [ - "{@link StatusServiceSetup}" ], "source": { - "path": "src/core/server/index.ts", - "lineNumber": 493 + "path": "src/core/server/elasticsearch/types.ts", + "lineNumber": 30 }, - "signature": [ + "deprecated": true, + "references": [ { - "pluginId": "core", - "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.StatusServiceSetup", - "text": "StatusServiceSetup" + "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.CoreSetup.uiSettings", + "parentPluginId": "core", + "id": "def-server.ElasticsearchServiceStart.client", "type": "Object", - "label": "uiSettings", - "description": [ - "{@link UiSettingsServiceSetup}" - ], - "source": { - "path": "src/core/server/index.ts", - "lineNumber": 495 - }, + "tags": [], + "label": "client", + "description": [ + "\nA pre-configured {@link IClusterClient | Elasticsearch client}\n" + ], "signature": [ { "pluginId": "core", "scope": "server", "docId": "kibCorePluginApi", - "section": "def-server.UiSettingsServiceSetup", - "text": "UiSettingsServiceSetup" + "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.CoreSetup.deprecations", - "type": "Object", - "label": "deprecations", + "label": "createClient", "description": [ - "{@link DeprecationsServiceSetup}" + "\nCreate application specific Elasticsearch cluster API client with customized config. See {@link IClusterClient}.\n" ], - "source": { - "path": "src/core/server/index.ts", - "lineNumber": 497 - }, "signature": [ + "(type: string, clientConfig?: Partial<", { "pluginId": "core", "scope": "server", "docId": "kibCorePluginApi", - "section": "def-server.DeprecationsServiceSetup", - "text": "DeprecationsServiceSetup" + "section": "def-server.ElasticsearchClientConfig", + "text": "ElasticsearchClientConfig" + }, + "> | undefined) => ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.ICustomClusterClient", + "text": "ICustomClusterClient" } - ] - }, - { - "tags": [], - "id": "def-server.CoreSetup.getStartServices", - "type": "Function", - "label": "getStartServices", - "description": [ - "{@link StartServicesAccessor}" ], "source": { - "path": "src/core/server/index.ts", - "lineNumber": 499 + "path": "src/core/server/elasticsearch/types.ts", + "lineNumber": 114 }, + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.ElasticsearchServiceStart.legacy", + "type": "Object", + "tags": [ + "deprecated" + ], + "label": "legacy", + "description": [], "signature": [ + "{ readonly config$: ", + "Observable", + "<", { "pluginId": "core", "scope": "server", "docId": "kibCorePluginApi", - "section": "def-server.StartServicesAccessor", - "text": "StartServicesAccessor" + "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<", + { + "pluginId": "core", + "scope": "server", + "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" + } + ], + "source": { + "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/index.ts", - "lineNumber": 472 - }, "initialIsOpen": false }, { - "id": "def-server.CoreStart", + "parentPluginId": "core", + "id": "def-server.ElasticsearchStatusMeta", "type": "Interface", - "label": "CoreStart", - "description": [ - "\nContext passed to the plugins `start` method.\n" - ], - "tags": [ - "public" - ], + "tags": [], + "label": "ElasticsearchStatusMeta", + "description": [], + "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.CoreStart.capabilities", - "type": "Object", - "label": "capabilities", - "description": [ - "{@link CapabilitiesStart}" - ], - "source": { - "path": "src/core/server/index.ts", - "lineNumber": 522 - }, + "label": "warningNodes", + "description": [], "signature": [ - { - "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}" + "NodeInfo[]" ], "source": { - "path": "src/core/server/index.ts", - "lineNumber": 524 + "path": "src/core/server/elasticsearch/types.ts", + "lineNumber": 172 }, - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.ElasticsearchServiceStart", - "text": "ElasticsearchServiceStart" - } - ] + "deprecated": false }, { + "parentPluginId": "core", + "id": "def-server.ElasticsearchStatusMeta.incompatibleNodes", + "type": "Array", "tags": [], - "id": "def-server.CoreStart.http", - "type": "Object", - "label": "http", - "description": [ - "{@link HttpServiceStart}" + "label": "incompatibleNodes", + "description": [], + "signature": [ + "NodeInfo[]" ], "source": { - "path": "src/core/server/index.ts", - "lineNumber": 526 + "path": "src/core/server/elasticsearch/types.ts", + "lineNumber": 173 }, - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.HttpServiceStart", - "text": "HttpServiceStart" - } - ] - }, + "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.CoreStart.metrics", - "type": "Object", - "label": "metrics", - "description": [ - "{@link MetricsServiceStart}" + "label": "name", + "description": [], + "signature": [ + "\"production\" | \"development\"" ], "source": { - "path": "src/core/server/index.ts", - "lineNumber": 528 + "path": "node_modules/@kbn/config/target/types.d.ts", + "lineNumber": 15 }, - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.MetricsServiceSetup", - "text": "MetricsServiceSetup" - } - ] + "deprecated": false }, { + "parentPluginId": "core", + "id": "def-server.EnvironmentMode.dev", + "type": "boolean", "tags": [], - "id": "def-server.CoreStart.savedObjects", - "type": "Object", - "label": "savedObjects", - "description": [ - "{@link SavedObjectsServiceStart}" - ], + "label": "dev", + "description": [], "source": { - "path": "src/core/server/index.ts", - "lineNumber": 530 + "path": "node_modules/@kbn/config/target/types.d.ts", + "lineNumber": 16 }, - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsServiceStart", - "text": "SavedObjectsServiceStart" - } - ] + "deprecated": false }, { + "parentPluginId": "core", + "id": "def-server.EnvironmentMode.prod", + "type": "boolean", "tags": [], - "id": "def-server.CoreStart.uiSettings", - "type": "Object", - "label": "uiSettings", - "description": [ - "{@link UiSettingsServiceStart}" - ], + "label": "prod", + "description": [], "source": { - "path": "src/core/server/index.ts", - "lineNumber": 532 + "path": "node_modules/@kbn/config/target/types.d.ts", + "lineNumber": 17 }, - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.UiSettingsServiceStart", - "text": "UiSettingsServiceStart" - } - ] + "deprecated": false } ], - "source": { - "path": "src/core/server/index.ts", - "lineNumber": 520 - }, "initialIsOpen": false }, { - "id": "def-server.CoreStatus", + "parentPluginId": "core", + "id": "def-server.FakeRequest", "type": "Interface", - "label": "CoreStatus", + "tags": [], + "label": "FakeRequest", "description": [ - "\nStatus of core services.\n" - ], - "tags": [ - "public" + "\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.CoreStatus.elasticsearch", - "type": "Object", - "label": "elasticsearch", - "description": [], - "source": { - "path": "src/core/server/status/types.ts", - "lineNumber": 115 - }, + "label": "headers", + "description": [ + "Headers used for authentication against Elasticsearch" + ], "signature": [ { "pluginId": "core", "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.ServiceStatus", - "text": "ServiceStatus" - }, - "" - ] - }, - { - "tags": [], - "id": "def-server.CoreStatus.savedObjects", - "type": "Object", - "label": "savedObjects", - "description": [], + "docId": "kibCoreHttpPluginApi", + "section": "def-server.Headers", + "text": "Headers" + } + ], "source": { - "path": "src/core/server/status/types.ts", - "lineNumber": 116 + "path": "src/core/server/elasticsearch/types.ts", + "lineNumber": 182 }, - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.ServiceStatus", - "text": "ServiceStatus" - }, - "" - ] + "deprecated": false } ], - "source": { - "path": "src/core/server/status/types.ts", - "lineNumber": 114 - }, "initialIsOpen": false }, { - "id": "def-server.CountResponse", + "parentPluginId": "core", + "id": "def-server.GetDeprecationsContext", "type": "Interface", - "label": "CountResponse", + "tags": [], + "label": "GetDeprecationsContext", "description": [], - "tags": [ - "public" - ], + "source": { + "path": "src/core/server/deprecations/types.ts", + "lineNumber": 60 + }, + "deprecated": false, "children": [ { - "tags": [], - "id": "def-server.CountResponse._shards", + "parentPluginId": "core", + "id": "def-server.GetDeprecationsContext.esClient", "type": "Object", - "label": "_shards", + "tags": [], + "label": "esClient", "description": [], - "source": { - "path": "src/core/server/elasticsearch/client/types.ts", - "lineNumber": 72 - }, "signature": [ { "pluginId": "core", "scope": "server", "docId": "kibCorePluginApi", - "section": "def-server.ShardsInfo", - "text": "ShardsInfo" + "section": "def-server.IScopedClusterClient", + "text": "IScopedClusterClient" } - ] + ], + "source": { + "path": "src/core/server/deprecations/types.ts", + "lineNumber": 61 + }, + "deprecated": false }, { + "parentPluginId": "core", + "id": "def-server.GetDeprecationsContext.savedObjectsClient", + "type": "Object", "tags": [], - "id": "def-server.CountResponse.count", - "type": "number", - "label": "count", + "label": "savedObjectsClient", "description": [], + "signature": [ + "Pick<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsClient", + "text": "SavedObjectsClient" + }, + ", \"get\" | \"delete\" | \"create\" | \"bulkCreate\" | \"checkConflicts\" | \"find\" | \"bulkGet\" | \"resolve\" | \"update\" | \"addToNamespaces\" | \"deleteFromNamespaces\" | \"bulkUpdate\" | \"removeReferencesTo\" | \"openPointInTimeForType\" | \"closePointInTime\" | \"createPointInTimeFinder\" | \"errors\">" + ], "source": { - "path": "src/core/server/elasticsearch/client/types.ts", - "lineNumber": 73 - } + "path": "src/core/server/deprecations/types.ts", + "lineNumber": 62 + }, + "deprecated": false } ], - "source": { - "path": "src/core/server/elasticsearch/client/types.ts", - "lineNumber": 71 - }, "initialIsOpen": false }, { - "id": "def-server.DeleteDocumentResponse", + "parentPluginId": "core", + "id": "def-server.GetResponse", "type": "Interface", - "label": "DeleteDocumentResponse", + "tags": [], + "label": "GetResponse", "description": [], - "tags": [ - "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.DeleteDocumentResponse._shards", - "type": "Object", - "label": "_shards", + "label": "_index", "description": [], "source": { "path": "src/core/server/elasticsearch/client/types.ts", - "lineNumber": 125 + "lineNumber": 110 }, - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.ShardsResponse", - "text": "ShardsResponse" - } - ] + "deprecated": false }, { + "parentPluginId": "core", + "id": "def-server.GetResponse._type", + "type": "string", "tags": [], - "id": "def-server.DeleteDocumentResponse.found", - "type": "boolean", - "label": "found", + "label": "_type", "description": [], "source": { "path": "src/core/server/elasticsearch/client/types.ts", - "lineNumber": 126 - } + "lineNumber": 111 + }, + "deprecated": false }, { - "tags": [], - "id": "def-server.DeleteDocumentResponse._index", + "parentPluginId": "core", + "id": "def-server.GetResponse._id", "type": "string", - "label": "_index", - "description": [], - "source": { - "path": "src/core/server/elasticsearch/client/types.ts", - "lineNumber": 127 - } - }, - { "tags": [], - "id": "def-server.DeleteDocumentResponse._type", - "type": "string", - "label": "_type", + "label": "_id", "description": [], "source": { "path": "src/core/server/elasticsearch/client/types.ts", - "lineNumber": 128 - } + "lineNumber": 112 + }, + "deprecated": false }, { + "parentPluginId": "core", + "id": "def-server.GetResponse._version", + "type": "number", "tags": [], - "id": "def-server.DeleteDocumentResponse._id", - "type": "string", - "label": "_id", + "label": "_version", "description": [], "source": { "path": "src/core/server/elasticsearch/client/types.ts", - "lineNumber": 129 - } + "lineNumber": 113 + }, + "deprecated": false }, { + "parentPluginId": "core", + "id": "def-server.GetResponse._routing", + "type": "string", "tags": [], - "id": "def-server.DeleteDocumentResponse._version", - "type": "number", - "label": "_version", + "label": "_routing", "description": [], + "signature": [ + "string | undefined" + ], "source": { "path": "src/core/server/elasticsearch/client/types.ts", - "lineNumber": 130 - } + "lineNumber": 114 + }, + "deprecated": false }, { + "parentPluginId": "core", + "id": "def-server.GetResponse.found", + "type": "boolean", "tags": [], - "id": "def-server.DeleteDocumentResponse.result", - "type": "string", - "label": "result", + "label": "found", "description": [], "source": { "path": "src/core/server/elasticsearch/client/types.ts", - "lineNumber": 131 - } + "lineNumber": 115 + }, + "deprecated": false }, { + "parentPluginId": "core", + "id": "def-server.GetResponse._source", + "type": "Uncategorized", "tags": [], - "id": "def-server.DeleteDocumentResponse.error", - "type": "Object", - "label": "error", + "label": "_source", "description": [], + "signature": [ + "T" + ], "source": { "path": "src/core/server/elasticsearch/client/types.ts", - "lineNumber": 132 + "lineNumber": 116 }, - "signature": [ - "{ type: string; } | undefined" - ] - } - ], - "source": { - "path": "src/core/server/elasticsearch/client/types.ts", - "lineNumber": 124 - }, - "initialIsOpen": false - }, - { - "id": "def-server.DeprecationAPIClientParams", - "type": "Interface", - "label": "DeprecationAPIClientParams", - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.DeprecationAPIClientParams", - "text": "DeprecationAPIClientParams" + "deprecated": false }, - " extends ", - "GenericParams" - ], - "description": [], - "tags": [ - "deprecated", - "public" - ], - "children": [ { + "parentPluginId": "core", + "id": "def-server.GetResponse._seq_no", + "type": "number", "tags": [], - "id": "def-server.DeprecationAPIClientParams.path", - "type": "string", - "label": "path", + "label": "_seq_no", "description": [], "source": { - "path": "src/core/server/elasticsearch/legacy/api_types.ts", - "lineNumber": 350 + "path": "src/core/server/elasticsearch/client/types.ts", + "lineNumber": 117 }, - "signature": [ - "\"/_migration/deprecations\"" - ] + "deprecated": false }, { + "parentPluginId": "core", + "id": "def-server.GetResponse._primary_term", + "type": "number", "tags": [], - "id": "def-server.DeprecationAPIClientParams.method", - "type": "string", - "label": "method", + "label": "_primary_term", "description": [], "source": { - "path": "src/core/server/elasticsearch/legacy/api_types.ts", - "lineNumber": 351 + "path": "src/core/server/elasticsearch/client/types.ts", + "lineNumber": 118 }, - "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.HttpResources", "type": "Interface", - "label": "DeprecationAPIResponse", - "description": [], - "tags": [ - "deprecated", - "public" + "tags": [], + "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." ], + "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.DeprecationAPIResponse.cluster_settings", - "type": "Array", - "label": "cluster_settings", - "description": [], - "source": { - "path": "src/core/server/elasticsearch/legacy/api_types.ts", - "lineNumber": 378 - }, + "label": "register", + "description": [ + "To register a route handler executing passed function to form response." + ], "signature": [ + "(route: ", { "pluginId": "core", "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.DeprecationInfo", - "text": "DeprecationInfo" + "docId": "kibCoreHttpPluginApi", + "section": "def-server.RouteConfig", + "text": "RouteConfig" }, - "[]" - ] - }, - { - "tags": [], - "id": "def-server.DeprecationAPIResponse.index_settings", - "type": "Object", - "label": "index_settings", - "description": [], - "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" - } - ] - } - ], - "source": { - "path": "src/core/server/elasticsearch/legacy/api_types.ts", - "lineNumber": 377 - }, - "initialIsOpen": false - }, - { - "id": "def-server.DeprecationInfo", - "type": "Interface", - "label": "DeprecationInfo", - "description": [], - "tags": [ - "deprecated", - "public" - ], - "children": [ - { - "tags": [], - "id": "def-server.DeprecationInfo.level", - "type": "CompoundType", - "label": "level", - "description": [], - "source": { - "path": "src/core/server/elasticsearch/legacy/api_types.ts", - "lineNumber": 359 - }, - "signature": [ + ", handler: ", { "pluginId": "core", "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.MIGRATION_DEPRECATION_LEVEL", - "text": "MIGRATION_DEPRECATION_LEVEL" - } - ] - }, - { - "tags": [], - "id": "def-server.DeprecationInfo.message", - "type": "string", - "label": "message", - "description": [], - "source": { - "path": "src/core/server/elasticsearch/legacy/api_types.ts", - "lineNumber": 360 - } - }, - { - "tags": [], - "id": "def-server.DeprecationInfo.url", - "type": "string", - "label": "url", - "description": [], - "source": { - "path": "src/core/server/elasticsearch/legacy/api_types.ts", - "lineNumber": 361 - } - }, - { - "tags": [], - "id": "def-server.DeprecationInfo.details", - "type": "string", - "label": "details", - "description": [], + "docId": "kibCoreHttpPluginApi", + "section": "def-server.RequestHandler", + "text": "RequestHandler" + }, + " | Error | { message: string | Error; attributes?: Record | undefined; } | Buffer | ", + "Stream" + ], "source": { - "path": "src/core/server/elasticsearch/legacy/api_types.ts", - "lineNumber": 362 + "path": "src/core/server/http_resources/types.ts", + "lineNumber": 101 }, - "signature": [ - "string | undefined" - ] + "deprecated": false } ], - "source": { - "path": "src/core/server/elasticsearch/legacy/api_types.ts", - "lineNumber": 358 - }, "initialIsOpen": false }, { - "id": "def-server.DeprecationsDetails", + "parentPluginId": "core", + "id": "def-server.HttpResourcesRenderOptions", "type": "Interface", - "label": "DeprecationsDetails", - "description": [], "tags": [], + "label": "HttpResourcesRenderOptions", + "description": [ + "\nAllows to configure HTTP response parameters" + ], + "source": { + "path": "src/core/server/http_resources/types.ts", + "lineNumber": 24 + }, + "deprecated": false, "children": [ { - "tags": [], - "id": "def-server.DeprecationsDetails.message", - "type": "string", - "label": "message", - "description": [], - "source": { - "path": "src/core/server/deprecations/types.ts", - "lineNumber": 20 - } - }, - { - "tags": [], - "id": "def-server.DeprecationsDetails.level", + "parentPluginId": "core", + "id": "def-server.HttpResourcesRenderOptions.headers", "type": "CompoundType", - "label": "level", + "tags": [], + "label": "headers", "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." + "\nHTTP Headers with additional information about response." ], - "source": { - "path": "src/core/server/deprecations/types.ts", - "lineNumber": 27 - }, - "signature": [ - "\"warning\" | \"critical\" | \"fetch_error\"" - ] - }, - { - "tags": [], - "id": "def-server.DeprecationsDetails.documentationUrl", - "type": "string", - "label": "documentationUrl", - "description": [], - "source": { - "path": "src/core/server/deprecations/types.ts", - "lineNumber": 29 - }, "signature": [ - "string | undefined" - ] - }, - { - "tags": [], - "id": "def-server.DeprecationsDetails.correctiveActions", - "type": "Object", - "label": "correctiveActions", - "description": [], + "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/deprecations/types.ts", - "lineNumber": 31 + "path": "src/core/server/http_resources/types.ts", + "lineNumber": 30 }, - "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.HttpResourcesServiceToolkit", "type": "Interface", - "label": "DeprecationSettings", + "tags": [], + "label": "HttpResourcesServiceToolkit", "description": [ - "\nUiSettings deprecation field options." - ], - "tags": [ - "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": [ { + "parentPluginId": "core", + "id": "def-server.HttpResourcesServiceToolkit.renderCoreApp", + "type": "Function", "tags": [], - "id": "def-server.DeprecationSettings.message", - "type": "string", - "label": "message", + "label": "renderCoreApp", "description": [ - "Deprecation message" + "To respond with HTML page bootstrapping Kibana application." + ], + "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/types/ui_settings.ts", - "lineNumber": 34 - } + "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.DeprecationSettings.docLinksKey", - "type": "string", - "label": "docLinksKey", + "label": "renderAnonymousCoreApp", "description": [ - "Key to documentation links" + "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/types/ui_settings.ts", - "lineNumber": 36 - } - } - ], - "source": { - "path": "src/core/types/ui_settings.ts", - "lineNumber": 32 - }, - "initialIsOpen": false - }, - { - "id": "def-server.DeprecationsServiceSetup", - "type": "Interface", - "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" - ], - "tags": [ - "gmail", - "public" - ], - "children": [ + "path": "src/core/server/http_resources/types.ts", + "lineNumber": 47 + }, + "deprecated": false + }, { - "tags": [], - "id": "def-server.DeprecationsServiceSetup.registerDeprecations", + "parentPluginId": "core", + "id": "def-server.HttpResourcesServiceToolkit.renderHtml", "type": "Function", - "label": "registerDeprecations", - "description": [], + "tags": [], + "label": "renderHtml", + "description": [ + "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/deprecations/deprecations_service.ts", - "lineNumber": 104 + "path": "src/core/server/http_resources/types.ts", + "lineNumber": 49 }, + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.HttpResourcesServiceToolkit.renderJs", + "type": "Function", + "tags": [], + "label": "renderJs", + "description": [ + "To respond with a custom JS script file." + ], "signature": [ - "(deprecationContext: ", + "(options: ", { "pluginId": "core", "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.RegisterDeprecationsConfig", - "text": "RegisterDeprecationsConfig" + "docId": "kibCoreHttpPluginApi", + "section": "def-server.HttpResponseOptions", + "text": "HttpResponseOptions" }, - ") => void" - ] - } - ], - "source": { - "path": "src/core/server/deprecations/deprecations_service.ts", - "lineNumber": 103 - }, + ") => ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.IKibanaResponse", + "text": "IKibanaResponse" + }, + "" + ], + "source": { + "path": "src/core/server/http_resources/types.ts", + "lineNumber": 51 + }, + "deprecated": false + } + ], "initialIsOpen": false }, { - "id": "def-server.DiscoveredPlugin", + "parentPluginId": "core", + "id": "def-server.I18nServiceSetup", "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" - ], + "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.id", - "type": "string", - "label": "id", - "description": [ - "\nIdentifier of the plugin." - ], - "source": { - "path": "src/core/server/plugins/types.ts", - "lineNumber": 222 - } - }, - { - "tags": [], - "id": "def-server.DiscoveredPlugin.configPath", - "type": "CompoundType", - "label": "configPath", + "label": "getLocale", "description": [ - "\nRoot configuration path used by the plugin, defaults to \"id\" in snake_case format." + "\nReturn the locale currently in use." ], - "source": { - "path": "src/core/server/plugins/types.ts", - "lineNumber": 227 - }, "signature": [ - "string | string[]" - ] - }, - { - "tags": [], - "id": "def-server.DiscoveredPlugin.requiredPlugins", - "type": "Object", - "label": "requiredPlugins", - "description": [ - "\nAn optional list of the other plugins that **must be** installed and enabled\nfor this plugin to function properly." + "() => string" ], "source": { - "path": "src/core/server/plugins/types.ts", - "lineNumber": 233 + "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.optionalPlugins", - "type": "Object", - "label": "optionalPlugins", + "label": "getTranslationFiles", "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 absolute paths to translation files currently in use." ], - "source": { - "path": "src/core/server/plugins/types.ts", - "lineNumber": 240 - }, "signature": [ - "readonly string[]" - ] - }, - { - "tags": [], - "id": "def-server.DiscoveredPlugin.requiredBundles", - "type": "Object", - "label": "requiredBundles", - "description": [ - "\nList of plugin ids that this plugin's UI code imports modules from that are\nnot in `requiredPlugins`.\n" + "() => string[]" ], "source": { - "path": "src/core/server/plugins/types.ts", - "lineNumber": 252 + "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": 218 - }, "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" + ], + "signature": [ + "(pluginOpaqueId: symbol, contextName: ContextName, provider: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.IContextProvider", + "text": "IContextProvider" + }, + ") => this" ], "source": { - "path": "src/core/server/elasticsearch/types.ts", - "lineNumber": 96 + "path": "src/core/server/context/container/context.ts", + "lineNumber": 150 }, - "signature": [ + "deprecated": false, + "children": [ + { + "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 + }, { - "pluginId": "core", - "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.IClusterClient", - "text": "IClusterClient" + "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": [], - "id": "def-server.ElasticsearchServiceStart.createClient", + "parentPluginId": "core", + "id": "def-server.IContextContainer.createHandler", "type": "Function", - "label": "createClient", + "tags": [], + "label": "createHandler", "description": [ - "\nCreate application specific Elasticsearch cluster API client with customized config. See {@link IClusterClient}.\n" + "\nCreate a new handler function pre-wired to context for the plugin.\n" ], - "source": { - "path": "src/core/server/elasticsearch/types.ts", - "lineNumber": 114 - }, "signature": [ - "(type: string, clientConfig?: Partial<", + "(pluginOpaqueId: symbol, handler: ", { "pluginId": "core", "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.ElasticsearchClientConfig", - "text": "ElasticsearchClientConfig" + "docId": "kibCoreHttpPluginApi", + "section": "def-server.RequestHandler", + "text": "RequestHandler" }, - "> | undefined) => ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.ICustomClusterClient", - "text": "ICustomClusterClient" - } - ] - }, - { - "tags": [ - "deprecated" - ], - "id": "def-server.ElasticsearchServiceStart.legacy", - "type": "Object", - "label": "legacy", - "description": [], - "source": { - "path": "src/core/server/elasticsearch/types.ts", - "lineNumber": 124 - }, - "signature": [ - "{ readonly config$: ", - "Observable", - "<", + "; readonly createClient: (type: string, clientConfig?: Partial<", + ", any, { custom: | Error | { message: string | Error; attributes?: Record | undefined; } | Buffer | ", + "Stream", + " | undefined>(options: ", { "pluginId": "core", "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.LegacyElasticsearchClientConfig", - "text": "LegacyElasticsearchClientConfig" + "docId": "kibCoreHttpPluginApi", + "section": "def-server.CustomHttpResponseOptions", + "text": "CustomHttpResponseOptions" }, - "> | undefined) => 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 }, - ", \"close\" | \"callAsInternalUser\" | \"asScoped\">; readonly client: Pick<", { - "pluginId": "core", - "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.LegacyClusterClient", - "text": "LegacyClusterClient" + "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": [], + "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.esClient", - "type": "Object", - "label": "esClient", - "description": [], - "source": { - "path": "src/core/server/deprecations/types.ts", - "lineNumber": 61 - }, + "label": "policy", + "description": [ + "\nA set of policies describing which external urls are allowed." + ], "signature": [ { "pluginId": "core", "scope": "server", "docId": "kibCorePluginApi", - "section": "def-server.IScopedClusterClient", - "text": "IScopedClusterClient" - } - ] - }, - { - "tags": [], - "id": "def-server.GetDeprecationsContext.savedObjectsClient", - "type": "Object", - "label": "savedObjectsClient", - "description": [], + "section": "def-server.IExternalUrlPolicy", + "text": "IExternalUrlPolicy" + }, + "[]" + ], "source": { - "path": "src/core/server/deprecations/types.ts", - "lineNumber": 62 + "path": "src/core/server/external_url/external_url_config.ts", + "lineNumber": 22 }, - "signature": [ - "Pick<", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsClient", - "text": "SavedObjectsClient" - }, - ", \"get\" | \"delete\" | \"create\" | \"bulkCreate\" | \"checkConflicts\" | \"find\" | \"bulkGet\" | \"resolve\" | \"update\" | \"addToNamespaces\" | \"deleteFromNamespaces\" | \"bulkUpdate\" | \"removeReferencesTo\" | \"openPointInTimeForType\" | \"closePointInTime\" | \"createPointInTimeFinder\" | \"errors\">" - ] + "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": [ { - "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": [], - "source": { - "path": "src/core/server/elasticsearch/client/types.ts", - "lineNumber": 111 - } - }, - { - "tags": [], - "id": "def-server.GetResponse._id", - "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 - }, - "signature": [ - "string | undefined" - ] - }, - { - "tags": [], - "id": "def-server.GetResponse.found", + "parentPluginId": "core", + "id": "def-server.IExternalUrlPolicy.allow", "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 + "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 }, - "signature": [ - "T" - ] + "deprecated": false }, { + "parentPluginId": "core", + "id": "def-server.IExternalUrlPolicy.host", + "type": "string", "tags": [], - "id": "def-server.GetResponse._seq_no", - "type": "number", - "label": "_seq_no", - "description": [], + "label": "host", + "description": [ + "\nOptional host describing the external destination.\nMay be combined with `protocol`.\n" + ], + "signature": [ + "string | undefined" + ], "source": { - "path": "src/core/server/elasticsearch/client/types.ts", - "lineNumber": 117 - } + "path": "src/core/server/external_url/external_url_config.ts", + "lineNumber": 46 + }, + "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 } ], - "source": { - "path": "src/core/server/http_resources/types.ts", - "lineNumber": 99 - }, "initialIsOpen": false }, { - "id": "def-server.HttpResourcesRenderOptions", + "parentPluginId": "core", + "id": "def-server.IndexSettingsDeprecationInfo", "type": "Interface", - "label": "HttpResourcesRenderOptions", - "description": [ - "\nAllows to configure HTTP response parameters" - ], "tags": [ - "public" + "deprecated" ], + "label": "IndexSettingsDeprecationInfo", + "description": [], + "source": { + "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": [], - "id": "def-server.HttpResourcesRenderOptions.headers", - "type": "CompoundType", - "label": "headers", - "description": [ - "\nHTTP Headers with additional information about response." + "label": "Unnamed", + "description": [], + "signature": [ + "any" ], "source": { - "path": "src/core/server/http_resources/types.ts", - "lineNumber": 30 + "path": "src/core/server/elasticsearch/legacy/api_types.ts", + "lineNumber": 370 }, - "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.IRenderOptions", "type": "Interface", - "label": "HttpResourcesServiceToolkit", - "description": [ - "\nExtended set of {@link KibanaResponseFactory} helpers used to respond with HTML or JS resource." - ], - "tags": [ - "public" - ], + "tags": [], + "label": "IRenderOptions", + "description": [], + "source": { + "path": "src/core/server/rendering/types.ts", + "lineNumber": 68 + }, + "deprecated": false, "children": [ { + "parentPluginId": "core", + "id": "def-server.IRenderOptions.includeUserSettings", + "type": "CompoundType", "tags": [], - "id": "def-server.HttpResourcesServiceToolkit.renderCoreApp", - "type": "Function", - "label": "renderCoreApp", + "label": "includeUserSettings", "description": [ - "To respond with HTML page bootstrapping Kibana application." + "\nSet whether to output user settings in the page metadata.\n`true` by default." ], - "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." + "boolean | undefined" ], "source": { - "path": "src/core/server/http_resources/types.ts", - "lineNumber": 47 + "path": "src/core/server/rendering/types.ts", + "lineNumber": 73 }, - "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 + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-server.IScopedClusterClient", + "type": "Interface", + "tags": [], + "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" + ], + "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.renderHtml", - "type": "Function", - "label": "renderHtml", + "label": "asInternalUser", "description": [ - "To respond with a custom HTML page." + "\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": 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" - }, - "" - ] + "docId": "kibCorePluginApi", + "section": "def-server.ElasticsearchClient", + "text": "ElasticsearchClient" + } + ], + "source": { + "path": "src/core/server/elasticsearch/client/scoped_cluster_client.ts", + "lineNumber": 24 + }, + "deprecated": false }, { + "parentPluginId": "core", + "id": "def-server.IScopedClusterClient.asCurrentUser", + "type": "CompoundType", "tags": [], - "id": "def-server.HttpResourcesServiceToolkit.renderJs", - "type": "Function", - "label": "renderJs", + "label": "asCurrentUser", "description": [ - "To respond with a custom JS script file." + "\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": 51 - }, "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" - }, - "" - ] + "docId": "kibCorePluginApi", + "section": "def-server.ElasticsearchClient", + "text": "ElasticsearchClient" + } + ], + "source": { + "path": "src/core/server/elasticsearch/client/scoped_cluster_client.ts", + "lineNumber": 29 + }, + "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." ], - "children": [], + "signature": [ + "(key: string) => Promise" + ], + "source": { + "path": "src/core/server/ui_settings/types.ts", + "lineNumber": 39 + }, + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.IUiSettingsClient.getAll", + "type": "Function", "tags": [], - "returnComment": [], + "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/i18n/i18n_service.ts", - "lineNumber": 31 - } + "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", + "tags": [], + "label": "getUserProvided", + "description": [ + "\nRetrieves a set of all uiSettings values set by the user." + ], "signature": [ - "() => string[]" + "() => Promise>>" ], + "source": { + "path": "src/core/server/ui_settings/types.ts", + "lineNumber": 47 + }, + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.IUiSettingsClient.setMany", + "type": "Function", + "tags": [], + "label": "setMany", "description": [ - "\nReturn the absolute paths to translation files currently in use." + "\nWrites multiple uiSettings values and marks them as set by the user." ], - "children": [], + "signature": [ + "(changes: Record) => Promise" + ], + "source": { + "path": "src/core/server/ui_settings/types.ts", + "lineNumber": 51 + }, + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.IUiSettingsClient.set", + "type": "Function", "tags": [], - "returnComment": [], + "label": "set", + "description": [ + "\nWrites uiSettings value and marks it as set by the user." + ], + "signature": [ + "(key: string, value: any) => Promise" + ], "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": 55 + }, + "deprecated": false + }, { + "parentPluginId": "core", + "id": "def-server.IUiSettingsClient.remove", + "type": "Function", "tags": [], - "id": "def-server.IClusterClient.asInternalUser", - "type": "CompoundType", - "label": "asInternalUser", + "label": "remove", "description": [ - "\nA {@link ElasticsearchClient | client} to be used to query the ES cluster on behalf of the Kibana internal user" + "\nRemoves uiSettings value by key." + ], + "signature": [ + "(key: string) => Promise" ], "source": { - "path": "src/core/server/elasticsearch/client/cluster_client.ts", - "lineNumber": 33 + "path": "src/core/server/ui_settings/types.ts", + "lineNumber": 59 }, + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.IUiSettingsClient.removeMany", + "type": "Function", + "tags": [], + "label": "removeMany", + "description": [ + "\nRemoves multiple uiSettings values by keys." + ], "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.ElasticsearchClient", - "text": "ElasticsearchClient" - } - ] + "(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": [], - "id": "def-server.IClusterClient.asScoped", + "label": "isOverridden", + "description": [ + "\nShows whether the uiSettings value set by the user." + ], + "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", - "label": "asScoped", + "tags": [], + "label": "isSensitive", "description": [ - "\nCreates a {@link IScopedClusterClient | scoped cluster client} bound to given {@link ScopeableRequest | request}" + "\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/elasticsearch/client/cluster_client.ts", - "lineNumber": 37 + "path": "src/core/server/ui_settings/types.ts", + "lineNumber": 71 }, - "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" - } - ] + "deprecated": false } ], - "source": { - "path": "src/core/server/elasticsearch/client/cluster_client.ts", - "lineNumber": 29 - }, "initialIsOpen": false }, { - "id": "def-server.IContextContainer", + "parentPluginId": "core", + "id": "def-server.LegacyAPICaller", "type": "Interface", - "label": "IContextContainer", - "description": [ - "\nAn object that handles registration of context providers and configuring handlers with context.\n" - ], "tags": [ - "public" + "deprecated" ], - "children": [ + "label": "LegacyAPICaller", + "description": [], + "source": { + "path": "src/core/server/elasticsearch/legacy/api_types.ts", + "lineNumber": 162 + }, + "deprecated": true, + "references": [ { - "id": "def-server.IContextContainer.registerContext", - "type": "Function", - "label": "registerContext", - "signature": [ - "(pluginOpaqueId: symbol, contextName: ContextName, provider: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.IContextProvider", - "text": "IContextProvider" - }, - ") => this" - ], - "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 - } - } - ], - "tags": [], - "returnComment": [ - "The {@link IContextContainer} for method chaining." - ], - "source": { - "path": "src/core/server/context/container/context.ts", - "lineNumber": 150 + "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 } }, { - "id": "def-server.IContextContainer.createHandler", - "type": "Function", - "label": "createHandler", - "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" - ], - "description": [ - "\nCreate a new handler function pre-wired to context for the plugin.\n" - ], - "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 - } - } - ], - "tags": [], - "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/context/container/context.ts", - "lineNumber": 164 + "plugin": "monitoring", + "link": { + "path": "x-pack/plugins/monitoring/server/telemetry_collection/get_es_stats.ts", + "lineNumber": 38 } - } - ], - "source": { - "path": "src/core/server/context/container/context.ts", - "lineNumber": 135 - }, - "initialIsOpen": false - }, - { - "id": "def-server.ICspConfig", - "type": "Interface", - "label": "ICspConfig", - "description": [ - "\nCSP configuration for use in Kibana." - ], - "tags": [ - "public" - ], - "children": [ + }, { - "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", - "lineNumber": 21 - }, - "signature": [ - "string[]" - ] + "plugin": "monitoring", + "link": { + "path": "x-pack/plugins/monitoring/server/telemetry_collection/get_kibana_stats.ts", + "lineNumber": 11 + } }, { - "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_kibana_stats.ts", + "lineNumber": 186 } }, { - "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", + "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 + } + }, + { + "plugin": "monitoring", + "link": { + "path": "x-pack/plugins/monitoring/server/telemetry_collection/get_cluster_uuids.ts", + "lineNumber": 21 + } + }, + { + "plugin": "monitoring", + "link": { + "path": "x-pack/plugins/monitoring/server/telemetry_collection/get_cluster_uuids.ts", "lineNumber": 33 } }, { - "tags": [], - "id": "def-server.ICspConfig.disableEmbedding", - "type": "boolean", - "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": "src/core/server/csp/csp_config.ts", - "lineNumber": 39 + "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": 45 + "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": [ + }, + { + "plugin": "monitoring", + "link": { + "path": "x-pack/plugins/monitoring/server/telemetry_collection/get_licenses.ts", + "lineNumber": 35 + } + }, + { + "plugin": "monitoring", + "link": { + "path": "x-pack/plugins/monitoring/server/lib/alerts/disable_watcher_cluster_alerts.ts", + "lineNumber": 9 + } + }, + { + "plugin": "monitoring", + "link": { + "path": "x-pack/plugins/monitoring/server/lib/alerts/disable_watcher_cluster_alerts.ts", + "lineNumber": 25 + } + }, + { + "plugin": "monitoring", + "link": { + "path": "x-pack/plugins/monitoring/server/lib/alerts/disable_watcher_cluster_alerts.ts", + "lineNumber": 36 + } + }, + { + "plugin": "monitoring", + "link": { + "path": "x-pack/plugins/monitoring/target/types/server/telemetry_collection/get_es_stats.d.ts", + "lineNumber": 2 + } + }, + { + "plugin": "monitoring", + "link": { + "path": "x-pack/plugins/monitoring/target/types/server/telemetry_collection/get_es_stats.d.ts", + "lineNumber": 10 + } + }, + { + "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 + } + }, { - "pluginId": "core", - "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.ICustomClusterClient", - "text": "ICustomClusterClient" + "plugin": "monitoring", + "link": { + "path": "x-pack/plugins/monitoring/target/types/server/telemetry_collection/get_beats_stats.d.ts", + "lineNumber": 120 + } }, - " 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/target/types/server/telemetry_collection/get_beats_stats.d.ts", + "lineNumber": 123 + } + }, { - "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/target/types/server/telemetry_collection/get_beats_stats.d.ts", + "lineNumber": 129 + } + }, { - "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/target/types/server/telemetry_collection/get_logstash_stats.d.ts", + "lineNumber": 2 + } + }, { - "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_logstash_stats.d.ts", + "lineNumber": 100 } }, { - "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_logstash_stats.d.ts", + "lineNumber": 103 + } }, { - "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_logstash_stats.d.ts", + "lineNumber": 109 + } + }, { - "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_all_stats.d.ts", + "lineNumber": 1 + } + }, { - "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_all_stats.d.ts", + "lineNumber": 11 + } + }, { - "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_cluster_uuids.d.ts", + "lineNumber": 1 + } + }, + { + "plugin": "monitoring", + "link": { + "path": "x-pack/plugins/monitoring/target/types/server/telemetry_collection/get_cluster_uuids.d.ts", + "lineNumber": 5 + } + }, { - "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_cluster_uuids.d.ts", + "lineNumber": 10 + } }, { - "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_licenses.d.ts", + "lineNumber": 2 + } + }, { - "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_licenses.d.ts", + "lineNumber": 7 + } }, { - "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_licenses.d.ts", + "lineNumber": 20 + } }, { - "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/lib/alerts/disable_watcher_cluster_alerts.d.ts", + "lineNumber": 2 + } }, { - "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/lib/alerts/disable_watcher_cluster_alerts.d.ts", + "lineNumber": 3 + } }, { - "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/kibana_monitoring/collectors/lib/fetch_es_usage.d.ts", + "lineNumber": 1 + } }, { - "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_es_usage.d.ts", + "lineNumber": 4 + } }, { - "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": 1 + } }, { - "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_license_type.d.ts", + "lineNumber": 2 + } }, { - "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": 1 + } }, { - "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/fetch_stack_product_usage.d.ts", + "lineNumber": 4 + } + }, + { + "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", @@ -12814,51 +16146,59 @@ "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", + "description": [ + "\nLog messages at the most detailed log level\n" + ], "signature": [ "(message: string, meta?: Meta | undefined) => void" ], - "description": [ - "\nLog messages at the most detailed log level\n" - ], + "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": 16 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "core", "id": "def-server.Logger.trace.$2", "type": "Uncategorized", + "tags": [], "label": "meta", - "isRequired": false, - "signature": [ - "Meta | undefined" - ], "description": [ "-" ], + "signature": [ + "Meta | undefined" + ], "source": { "path": "node_modules/@kbn/logging/target/logger.d.ts", "lineNumber": 16 - } + }, + "deprecated": false, + "isRequired": false } ], - "tags": [], - "returnComment": [], - "source": { - "path": "node_modules/@kbn/logging/target/logger.d.ts", - "lineNumber": 16 - } + "returnComment": [] }, { + "parentPluginId": "core", "id": "def-server.Logger.debug", "type": "Function", + "tags": [], "label": "debug", + "description": [ + "\nLog messages useful for debugging and interactive investigation" + ], "signature": [ "(message: string, meta?: Meta | undefined) => void" ], - "description": [ - "\nLog messages useful for debugging and interactive investigation" - ], + "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": 22 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "core", "id": "def-server.Logger.debug.$2", "type": "Uncategorized", + "tags": [], "label": "meta", - "isRequired": false, - "signature": [ - "Meta | undefined" - ], "description": [ "-" ], + "signature": [ + "Meta | undefined" + ], "source": { "path": "node_modules/@kbn/logging/target/logger.d.ts", "lineNumber": 22 - } + }, + "deprecated": false, + "isRequired": false } ], - "tags": [], - "returnComment": [], - "source": { - "path": "node_modules/@kbn/logging/target/logger.d.ts", - "lineNumber": 22 - } + "returnComment": [] }, { + "parentPluginId": "core", "id": "def-server.Logger.info", "type": "Function", + "tags": [], "label": "info", + "description": [ + "\nLogs messages related to general application flow" + ], "signature": [ "(message: string, meta?: Meta | undefined) => void" ], - "description": [ - "\nLogs messages related to general application flow" - ], + "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": 28 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "core", "id": "def-server.Logger.info.$2", "type": "Uncategorized", + "tags": [], "label": "meta", - "isRequired": false, - "signature": [ - "Meta | undefined" - ], "description": [ "-" ], + "signature": [ + "Meta | undefined" + ], "source": { "path": "node_modules/@kbn/logging/target/logger.d.ts", "lineNumber": 28 - } + }, + "deprecated": false, + "isRequired": false } ], - "tags": [], - "returnComment": [], - "source": { - "path": "node_modules/@kbn/logging/target/logger.d.ts", - "lineNumber": 28 - } + "returnComment": [] }, { + "parentPluginId": "core", "id": "def-server.Logger.warn", "type": "Function", + "tags": [], "label": "warn", + "description": [ + "\nLogs abnormal or unexpected errors or messages" + ], "signature": [ "(errorOrMessage: string | Error, meta?: Meta | undefined) => void" ], - "description": [ - "\nLogs abnormal or unexpected errors or messages" - ], + "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": 34 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "core", "id": "def-server.Logger.warn.$2", "type": "Uncategorized", + "tags": [], "label": "meta", - "isRequired": false, - "signature": [ - "Meta | undefined" - ], "description": [ "-" ], + "signature": [ + "Meta | undefined" + ], "source": { "path": "node_modules/@kbn/logging/target/logger.d.ts", "lineNumber": 34 - } + }, + "deprecated": false, + "isRequired": false } ], - "tags": [], - "returnComment": [], - "source": { - "path": "node_modules/@kbn/logging/target/logger.d.ts", - "lineNumber": 34 - } + "returnComment": [] }, { + "parentPluginId": "core", "id": "def-server.Logger.error", "type": "Function", + "tags": [], "label": "error", + "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" ], - "description": [ - "\nLogs abnormal or unexpected errors or messages that caused a failure in the application flow\n" - ], + "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": 41 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "core", "id": "def-server.Logger.error.$2", "type": "Uncategorized", + "tags": [], "label": "meta", - "isRequired": false, - "signature": [ - "Meta | undefined" - ], "description": [ "-" ], + "signature": [ + "Meta | undefined" + ], "source": { "path": "node_modules/@kbn/logging/target/logger.d.ts", "lineNumber": 41 - } + }, + "deprecated": false, + "isRequired": false } ], - "tags": [], - "returnComment": [], - "source": { - "path": "node_modules/@kbn/logging/target/logger.d.ts", - "lineNumber": 41 - } + "returnComment": [] }, { + "parentPluginId": "core", "id": "def-server.Logger.fatal", "type": "Function", + "tags": [], "label": "fatal", + "description": [ + "\nLogs abnormal or unexpected errors or messages that caused an unrecoverable failure\n" + ], "signature": [ "(errorOrMessage: string | Error, meta?: Meta | undefined) => void" ], - "description": [ - "\nLogs abnormal or unexpected errors or messages that caused an unrecoverable failure\n" - ], + "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": 48 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "core", "id": "def-server.Logger.fatal.$2", "type": "Uncategorized", + "tags": [], "label": "meta", - "isRequired": false, - "signature": [ - "Meta | undefined" - ], "description": [ "-" ], + "signature": [ + "Meta | undefined" + ], "source": { "path": "node_modules/@kbn/logging/target/logger.d.ts", "lineNumber": 48 - } + }, + "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.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": 60 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "node_modules/@kbn/logging/target/logger.d.ts", - "lineNumber": 60 - } + "returnComment": [] } ], - "source": { - "path": "node_modules/@kbn/logging/target/logger.d.ts", - "lineNumber": 9 - }, "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", @@ -13373,15 +16775,19 @@ }, ">) => void" ], - "description": [ - "\nCustomizes the logging config for the plugin's context.\n" - ], + "source": { + "path": "src/core/server/logging/logging_service.ts", + "lineNumber": 41 + }, + "deprecated": false, "children": [ { + "parentPluginId": "core", "id": "def-server.LoggingServiceSetup.configure.$1", "type": "Object", + "tags": [], "label": "config$", - "isRequired": true, + "description": [], "signature": [ "Observable", "<", @@ -13394,42 +16800,39 @@ }, ">" ], - "description": [], "source": { "path": "src/core/server/logging/logging_service.ts", "lineNumber": 41 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/core/server/logging/logging_service.ts", - "lineNumber": 41 - } + "returnComment": [] } ], - "source": { - "path": "src/core/server/logging/logging_service.ts", - "lineNumber": 20 - }, "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" @@ -13437,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", @@ -13463,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", @@ -13597,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", @@ -13619,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" @@ -13664,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" @@ -13711,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" @@ -13788,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" @@ -13867,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" @@ -13880,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" @@ -13893,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" @@ -13956,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", @@ -14053,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: ", { @@ -14075,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", @@ -14092,38 +17573,40 @@ }, "" ], - "description": [], "source": { "path": "src/core/server/plugins/types.ts", "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": 288 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/core/server/plugins/types.ts", - "lineNumber": 288 - } + "returnComment": [] }, { + "parentPluginId": "core", "id": "def-server.Plugin.start", "type": "Function", + "tags": [], "label": "start", + "description": [], "signature": [ "(core: ", { @@ -14135,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", @@ -14151,61 +17640,63 @@ "text": "CoreStart" } ], - "description": [], "source": { "path": "src/core/server/plugins/types.ts", "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": 290 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/core/server/plugins/types.ts", - "lineNumber": 290 - } + "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": 292 - } + }, + "deprecated": false, + "children": [], + "returnComment": [] } ], - "source": { - "path": "src/core/server/plugins/types.ts", - "lineNumber": 282 - }, "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-server.PluginConfigDescriptor", "type": "Interface", + "tags": [], "label": "PluginConfigDescriptor", + "description": [ + "\nDescribes a plugin configuration properties.\n" + ], "signature": [ { "pluginId": "core", @@ -14216,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." ], + "signature": [ + "ConfigDeprecationProvider", + " | undefined" + ], "source": { "path": "src/core/server/plugins/types.ts", "lineNumber": 64 }, - "signature": [ - "ConfigDeprecationProvider", - " | undefined" - ] + "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": 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": 74 - }, "signature": [ { "pluginId": "core", @@ -14277,20 +17768,22 @@ "text": "PluginConfigSchema" }, "" - ] + ], + "source": { + "path": "src/core/server/plugins/types.ts", + "lineNumber": 74 + }, + "deprecated": false }, { - "tags": [], + "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}" ], - "source": { - "path": "src/core/server/plugins/types.ts", - "lineNumber": 85 - }, "signature": [ { "pluginId": "core", @@ -14300,19 +17793,25 @@ "text": "MakeUsageFromSchema" }, " | undefined" - ] + ], + "source": { + "path": "src/core/server/plugins/types.ts", + "lineNumber": 85 + }, + "deprecated": false } ], - "source": { - "path": "src/core/server/plugins/types.ts", - "lineNumber": 60 - }, "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", @@ -14323,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": 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": 339 - }, "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": 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": 366 - }, "signature": [ "{ legacy: { globalConfig$: ", "Observable", @@ -14401,30 +17902,36 @@ "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": 337 - }, "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." @@ -14432,12 +17939,14 @@ "source": { "path": "src/core/server/plugins/types.ts", "lineNumber": 140 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-server.PluginManifest.version", "type": "string", + "tags": [], "label": "version", "description": [ "\nVersion of the plugin." @@ -14445,12 +17954,14 @@ "source": { "path": "src/core/server/plugins/types.ts", "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\"." @@ -14458,76 +17969,86 @@ "source": { "path": "src/core/server/plugins/types.ts", "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": 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": 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": 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": 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." @@ -14535,12 +18056,14 @@ "source": { "path": "src/core/server/plugins/types.ts", "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." @@ -14548,66 +18071,71 @@ "source": { "path": "src/core/server/plugins/types.ts", "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": 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": 210 }, - "signature": [ - "readonly string[] | undefined" - ] + "deprecated": false } ], - "source": { - "path": "src/core/server/plugins/types.ts", - "lineNumber": 135 - }, "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: ", { @@ -14626,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": 440 - }, "signature": [ "{ savedObjects: { client: Pick<", { @@ -14697,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": 439 - }, "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." @@ -14728,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`" @@ -14759,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." @@ -14772,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", @@ -15055,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", @@ -15114,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", @@ -15181,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", @@ -15208,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." @@ -15221,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", "<", @@ -15434,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", "<", @@ -15459,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", @@ -15478,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", "<", @@ -15499,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", "<", @@ -15561,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", " | ", @@ -15894,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<", { @@ -16022,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<", { @@ -16042,132 +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" ], - "source": { - "path": "node_modules/@kbn/config/target/deprecation/types.d.ts", - "lineNumber": 6 - }, "signature": [ "(details: ", "DeprecatedConfigDetails", ") => void" ], + "source": { + "path": "node_modules/@kbn/config/target/deprecation/types.d.ts", + "lineNumber": 6 + }, + "deprecated": false, "initialIsOpen": false }, { - "tags": [ - "public" - ], + "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": [ + "\"kbnAppWrapper\"" + ], "source": { "path": "src/core/utils/app_wrapper_class.ts", "lineNumber": 13 }, - "signature": [ - "\"kbnAppWrapper\"" - ], + "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", " | ", @@ -16179,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: ", { @@ -16233,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", @@ -16277,222 +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 }, - "signature": [ - "string | string[]" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-server.Ecs", "type": "Type", + "tags": [], "label": "Ecs", - "tags": [ - "public" - ], "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 }, - "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; }" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-server.EcsEventCategory", "type": "Type", + "tags": [], "label": "EcsEventCategory", - "tags": [ - "public" - ], "description": [], + "signature": [ + "\"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 }, - "signature": [ - "\"host\" | \"authentication\" | \"database\" | \"package\" | \"session\" | \"network\" | \"file\" | \"process\" | \"registry\" | \"web\" | \"configuration\" | \"driver\" | \"iam\" | \"intrusion_detection\" | \"malware\"" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-server.EcsEventKind", "type": "Type", + "tags": [], "label": "EcsEventKind", - "tags": [ - "public" - ], "description": [], + "signature": [ + "\"alert\" | \"event\" | \"state\" | \"metric\" | \"signal\" | \"pipeline_error\"" + ], "source": { "path": "node_modules/@kbn/logging/target/ecs/event.d.ts", "lineNumber": 40 }, - "signature": [ - "\"alert\" | \"event\" | \"state\" | \"metric\" | \"signal\" | \"pipeline_error\"" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-server.EcsEventOutcome", "type": "Type", + "tags": [], "label": "EcsEventOutcome", - "tags": [ - "public" - ], "description": [], + "signature": [ + "\"success\" | \"failure\" | \"unknown\"" + ], "source": { "path": "node_modules/@kbn/logging/target/ecs/event.d.ts", "lineNumber": 44 }, - "signature": [ - "\"success\" | \"failure\" | \"unknown\"" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-server.EcsEventType", "type": "Type", - "label": "EcsEventType", - "tags": [ - "public" - ], + "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 }, - "signature": [ - "\"start\" | \"connection\" | \"end\" | \"user\" | \"info\" | \"error\" | \"group\" | \"protocol\" | \"access\" | \"admin\" | \"allowed\" | \"change\" | \"creation\" | \"deletion\" | \"denied\" | \"installation\"" - ], + "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: ", { @@ -16523,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: ", { @@ -16588,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", @@ -16632,236 +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 + } + }, { - "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": 1 + } }, - " | ", { - "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": 27 + } }, - " | ", { - "pluginId": "core", - "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.FakeRequest", - "text": "FakeRequest" + "plugin": "indexManagement", + "link": { + "path": "x-pack/plugins/index_management/target/types/server/types.d.ts", + "lineNumber": 33 + } }, - " | 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": 1 + } + }, + { + "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": [], - "source": { - "path": "src/core/server/logging/logging_config.ts", - "lineNumber": 60 - }, "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", - "tags": [ - "public" - ], "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": [ + "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 }, - "signature": [ - "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; }" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-server.MakeUsageFromSchema", "type": "Type", + "tags": [], "label": "MakeUsageFromSchema", - "tags": [ - "public" - ], "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 }, - "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; }" - ], + "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" ], + "signature": [ + "Type" + ], "source": { "path": "src/core/server/plugins/types.ts", "lineNumber": 28 }, - "signature": [ - "Type" - ], + "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": 444 - }, "signature": [ "(core: ", { @@ -16889,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" ], + "signature": [ + "string" + ], "source": { "path": "src/core/server/plugins/types.ts", "lineNumber": 114 }, - "signature": [ - "string" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-server.PluginOpaqueId", "type": "Type", + "tags": [], "label": "PluginOpaqueId", - "tags": [ - "public" - ], "description": [], + "signature": [ + "symbol" + ], "source": { "path": "src/core/server/plugins/types.ts", "lineNumber": 117 }, - "signature": [ - "symbol" - ], + "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", @@ -16967,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", @@ -17028,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": 325 - }, "signature": [ "{ readonly kibana: Readonly<{ readonly index: string; readonly autocompleteTerminateAfter: Readonly<{ clone: () => ", "Duration", @@ -17073,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": 510 - }, "signature": [ "() => Promise<[", { @@ -17100,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 96c2319997e8c..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": 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": 709 - }, "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": 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": 717 - } + }, + "deprecated": false, + "isRequired": false } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/core/public/application/types.ts", - "lineNumber": 717 - } + "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": 755 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/core/public/application/types.ts", - "lineNumber": 755 - } + "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": 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": 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": 769 }, - "signature": [ - "boolean | undefined" - ] + "deprecated": false } - ], - "source": { - "path": "src/core/public/application/types.ts", - "lineNumber": 769 - } + ] } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/core/public/application/types.ts", - "lineNumber": 769 - } + "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." ], + "signature": [ + "Observable", + "" + ], "source": { "path": "src/core/public/application/types.ts", "lineNumber": 774 }, - "signature": [ - "Observable", - "" - ] + "deprecated": false } ], - "source": { - "path": "src/core/public/application/types.ts", - "lineNumber": 696 - }, "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,104 +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 }, - "signature": [ - "boolean | undefined" - ] + "deprecated": false }, { - "tags": [], + "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 }, - "signature": [ - "boolean | undefined" - ] + "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" ], @@ -1581,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" ], @@ -1597,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" ], @@ -1613,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", @@ -1648,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", @@ -1677,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: ", { @@ -1720,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?: ", { @@ -1755,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: ", { @@ -1828,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 b36687dd1aeb3..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": [ - "\"modern\" | \"legacy\"" - ], + "deprecated": false, "initialIsOpen": false } ], diff --git a/api_docs/core_http.json b/api_docs/core_http.json index 1bd972f058277..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", @@ -1921,72 +2118,71 @@ }, "" ], - "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" - ] - } - ], - "source": { - "path": "src/core/public/http/types.ts", - "lineNumber": 322 - }, + }, + "deprecated": false + } + ], "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,150 +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": 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": 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 }, { - "tags": [], + "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 }, - "signature": [ - "boolean | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-server.CustomHttpResponseOptions.statusCode", "type": "number", + "tags": [], "label": "statusCode", "description": [], "source": { "path": "src/core/server/http/router/response.ts", "lineNumber": 86 - } + }, + "deprecated": false } ], - "source": { - "path": "src/core/server/http/router/response.ts", - "lineNumber": 79 - }, "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": 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": 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": 103 - }, "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", @@ -3125,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", @@ -3147,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", @@ -3187,62 +3492,72 @@ "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 }, - "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.HttpResponseOptions.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": 66 }, - "signature": [ - "boolean | undefined" - ] + "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" @@ -3250,12 +3565,14 @@ "source": { "path": "src/core/server/http/types.ts", "lineNumber": 343 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-server.HttpServerInfo.hostname", "type": "string", + "tags": [], "label": "hostname", "description": [ "The hostname of the server" @@ -3263,12 +3580,14 @@ "source": { "path": "src/core/server/http/types.ts", "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" @@ -3276,54 +3595,54 @@ "source": { "path": "src/core/server/http/types.ts", "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": 349 }, - "signature": [ - "\"http\" | \"https\" | \"socket\"" - ] + "deprecated": false } ], - "source": { - "path": "src/core/server/http/types.ts", - "lineNumber": 341 - }, "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: ", { @@ -3342,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: ", { @@ -3366,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: ", { @@ -3390,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: ", { @@ -3414,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: ", { @@ -3438,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: ", { @@ -3462,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<", { @@ -3486,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", @@ -3510,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", @@ -3532,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": [ " ", { @@ -3638,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": 315 - }, "signature": [ "Pick<", { @@ -3678,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": 321 - }, "signature": [ { "pluginId": "core", @@ -3700,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": 326 - }, "signature": [ "() => ", { @@ -3723,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": 310 - }, "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", @@ -3746,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", @@ -3796,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", @@ -3831,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", @@ -3870,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", @@ -3909,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", + "tags": [], "label": "detailed", - "isRequired": false, - "signature": [ - "boolean | undefined" - ], "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", @@ -4072,17 +4457,17 @@ }, "" ], - "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" @@ -4090,20 +4475,18 @@ "source": { "path": "src/core/server/http/router/router.ts", "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": 73 - }, "signature": [ { "pluginId": "core", @@ -4113,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": 80 - }, "signature": [ { "pluginId": "core", @@ -4136,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": 87 - }, "signature": [ { "pluginId": "core", @@ -4159,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": 94 - }, "signature": [ { "pluginId": "core", @@ -4182,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": 101 - }, "signature": [ { "pluginId": "core", @@ -4205,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": 107 - }, "signature": [ { "pluginId": "core", @@ -4227,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": 62 - }, "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", @@ -4302,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", @@ -4353,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", @@ -4377,176 +4786,203 @@ " extends ", "Request" ], - "description": [], - "tags": [ - "deprecated", - "public" - ], - "children": [], "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": [], "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" @@ -4554,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: ", { @@ -4596,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?: ", { @@ -4620,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", @@ -4691,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" @@ -4709,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 | ", { @@ -4733,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", @@ -4756,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", @@ -4779,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 ", { @@ -4864,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 ", { @@ -4888,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[] | ", { @@ -4930,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.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: ", { @@ -5032,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", @@ -5055,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", " | ", @@ -5089,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", " | ", @@ -5118,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", " | ", @@ -5147,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." @@ -5214,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", @@ -5253,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", @@ -5352,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." @@ -5370,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." @@ -5383,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[]) => ", { @@ -5406,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." @@ -5419,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", @@ -5458,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: ", { @@ -5493,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." ], @@ -5532,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: ", { @@ -5586,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", @@ -5644,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: ", { @@ -5699,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: ", { @@ -5742,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": 73 - }, "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: ", { @@ -5835,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 ", { @@ -5862,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." ], + "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 }, - "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; }" - ], + "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." ], + "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 }, - "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>; }" - ], + "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: ", { @@ -5971,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: ", { @@ -6023,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: ", { @@ -6066,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 - }, + "description": [ + "\nSee {@link OnPreRoutingToolkit}." + ], "signature": [ "(request: ", { @@ -6118,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" ], + "signature": [ + "HttpResponseOptions & { headers: { location: string;}; }" + ], "source": { "path": "src/core/server/http/router/response.ts", "lineNumber": 93 }, - "signature": [ - "HttpResponseOptions & { headers: { location: string;}; }" - ], + "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": 351 - }, "signature": [ "(context: Context, request: ", { @@ -6180,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: ", { @@ -6245,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": 377 - }, "signature": [ "(handler: ", { @@ -6280,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": 48 - }, "signature": [ "(route: ", { @@ -6421,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: ", { @@ -6456,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", " | ", @@ -6486,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": 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": 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": 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": 302 - } - } + "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 | ", @@ -6618,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": 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": 293 - }, "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 3d83baae0b722..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": 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": 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": 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": 221 + "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": 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,145 +195,109 @@ "text": "SavedObjectsBulkCreateOptions" } ], - "description": [], "source": { "path": "src/core/public/saved_objects/saved_objects_client.ts", "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": 256 - }, - "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": 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": 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": 287 - } + }, + "deprecated": false, + "isRequired": false } ], - "signature": [ - "(type: string, id: string, options?: ", - "SavedObjectsDeleteOptions", - " | undefined) => Promise<{}>" - ], - "description": [ - "\nDeletes an object\n" - ], - "label": "delete", - "source": { - "path": "src/core/public/saved_objects/saved_objects_client.ts", - "lineNumber": 284 - }, - "tags": [], "returnComment": [] }, { + "parentPluginId": "core", "id": "def-public.SavedObjectsClient.find", "type": "Function", - "children": [ - { - "id": "def-public.SavedObjectsClient.find.$1", - "type": "Object", - "label": "options", - "isRequired": true, - "signature": [ - "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\">" - ], - "description": [], - "source": { - "path": "src/core/public/saved_objects/saved_objects_client.ts", - "lineNumber": 315 - } - } + "tags": [ + "property", + "property", + "property", + "property", + "property", + "property", + "property" + ], + "label": "find", + "description": [ + "\nSearch for objects\n" ], "signature": [ "(options: Pick<", @@ -294,96 +318,115 @@ }, ">" ], - "description": [ - "\nSearch for objects\n" - ], - "label": "find", "source": { "path": "src/core/public/saved_objects/saved_objects_client.ts", "lineNumber": 314 }, - "tags": [ - "property" + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-public.SavedObjectsClient.find.$1", + "type": "Object", + "tags": [], + "label": "options", + "description": [], + "signature": [ + "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\">" + ], + "source": { + "path": "src/core/public/saved_objects/saved_objects_client.ts", + "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": [ + "(type: string, id: string) => 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": 381 + }, + "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": 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": 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": 381 - }, - "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": 404 - } - } + "tags": [], + "label": "bulkGet", + "description": [ + "\nReturns an array of objects by id\n" ], "signature": [ "(objects?: { id: string; type: string; }[]) => Promise<", @@ -396,23 +439,46 @@ }, ">" ], - "description": [ - "\nReturns an array of objects by id\n" - ], - "label": "bulkGet", "source": { "path": "src/core/public/saved_objects/saved_objects_client.ts", "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, references, upsert }?: ", { @@ -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": 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": 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": 438 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "core", "id": "def-public.SavedObjectsClient.update.$4", "type": "Object", + "tags": [], "label": "{ version, references, upsert }", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "core", @@ -493,26 +572,25 @@ }, "" ], - "description": [], "source": { "path": "src/core/public/saved_objects/saved_objects_client.ts", "lineNumber": 439 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [ - "prop" - ], - "returnComment": [], - "source": { - "path": "src/core/public/saved_objects/saved_objects_client.ts", - "lineNumber": 435 - } + "returnComment": [] }, { + "parentPluginId": "core", "id": "def-public.SavedObjectsClient.bulkUpdate", "type": "Function", + "tags": [], "label": "bulkUpdate", + "description": [ + "\nUpdate multiple documents at once\n" + ], "signature": [ "(objects?: ", { @@ -532,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", @@ -551,37 +635,26 @@ }, "[]" ], - "description": [ - "- [{ type, id, attributes, options: { version, references } }]" - ], "source": { "path": "src/core/public/saved_objects/saved_objects_client.ts", "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": 467 - } + ] } ], - "source": { - "path": "src/core/public/saved_objects/saved_objects_client.ts", - "lineNumber": 166 - }, "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" @@ -596,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": [], + "signature": [ + "SavedObjectReference", + "[]" + ], "source": { "path": "src/core/public/saved_objects/simple_saved_object.ts", "lineNumber": 32 }, - "signature": [ - "SavedObjectReference", - "[]" - ] + "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<", { @@ -731,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<", { @@ -882,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": 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", @@ -931,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": 88 - }, "signature": [ { "pluginId": "core", @@ -955,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": 87 - }, "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-public.SavedObjectsBulkCreateObject", "type": "Interface", + "tags": [], "label": "SavedObjectsBulkCreateObject", + "description": [], "signature": [ { "pluginId": "core", @@ -985,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", @@ -1068,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", @@ -1293,88 +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": [ { - "tags": [], + "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 }, - "signature": [ - "A | undefined" - ] + "deprecated": false }, { - "tags": [], + "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": 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": 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": 110 - } + }, + "deprecated": false } ], - "source": { - "path": "src/core/public/saved_objects/saved_objects_client.ts", - "lineNumber": 105 - }, "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<", { @@ -1385,19 +1544,23 @@ "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": [], "signature": [ { "pluginId": "core", @@ -1408,81 +1571,84 @@ }, "" ], - "description": [], - "tags": [ - "public" - ], + "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 }, { - "tags": [], + "parentPluginId": "core", "id": "def-public.SavedObjectsUpdateOptions.upsert", "type": "Uncategorized", + "tags": [], "label": "upsert", "description": [], + "signature": [ + "Attributes | undefined" + ], "source": { "path": "src/core/public/saved_objects/saved_objects_client.ts", "lineNumber": 82 }, - "signature": [ - "Attributes | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-public.SavedObjectsUpdateOptions.references", "type": "Array", + "tags": [], "label": "references", "description": [], + "signature": [ + "SavedObjectReference", + "[] | undefined" + ], "source": { "path": "src/core/public/saved_objects/saved_objects_client.ts", "lineNumber": 83 }, - "signature": [ - "SavedObjectReference", - "[] | undefined" - ] + "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": 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, references, upsert }?: SavedObjectsUpdateOptions) => Promise>; bulkUpdate: (objects?: SavedObjectsBulkUpdateObject[]) => Promise>; }" - ], + "deprecated": false, "initialIsOpen": false } ], @@ -1491,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": 405 - }, "signature": [ "typeof ", { @@ -1520,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": 406 - }, "signature": [ "typeof ", { @@ -1541,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?: ", { @@ -1560,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": 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": 422 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "core", "id": "def-server.SavedObjectsClient.create.$3", "type": "Object", + "tags": [], "label": "options", - "isRequired": false, + "description": [], "signature": [ { "pluginId": "core", @@ -1607,24 +1796,25 @@ }, " | undefined" ], - "description": [], "source": { "path": "src/core/server/saved_objects/service/saved_objects_client.ts", "lineNumber": 422 - } + }, + "deprecated": false, + "isRequired": false } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "lineNumber": 422 - } + "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: ", { @@ -1652,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", @@ -1671,17 +1865,20 @@ }, "[]" ], - "description": [], "source": { "path": "src/core/server/saved_objects/service/saved_objects_client.ts", "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", @@ -1692,24 +1889,25 @@ }, " | undefined" ], - "description": [], "source": { "path": "src/core/server/saved_objects/service/saved_objects_client.ts", "lineNumber": 434 - } + }, + "deprecated": false, + "isRequired": false } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "lineNumber": 432 - } + "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?: ", { @@ -1737,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", @@ -1756,17 +1958,20 @@ }, "[]" ], - "description": [], "source": { "path": "src/core/server/saved_objects/service/saved_objects_client.ts", "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", @@ -1776,24 +1981,25 @@ "text": "SavedObjectsBaseOptions" } ], - "description": [], "source": { "path": "src/core/server/saved_objects/service/saved_objects_client.ts", "lineNumber": 448 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "lineNumber": 446 - } + "returnComment": [] }, { + "parentPluginId": "core", "id": "def-server.SavedObjectsClient.delete", "type": "Function", + "tags": [], "label": "delete", + "description": [ + "\nDeletes a SavedObject\n" + ], "signature": [ "(type: string, id: string, options?: ", { @@ -1805,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": 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": 460 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "core", "id": "def-server.SavedObjectsClient.delete.$3", "type": "Object", + "tags": [], "label": "options", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "core", @@ -1851,24 +2067,25 @@ "text": "SavedObjectsDeleteOptions" } ], - "description": [], "source": { "path": "src/core/server/saved_objects/service/saved_objects_client.ts", "lineNumber": 460 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "lineNumber": 460 - } + "returnComment": [] }, { + "parentPluginId": "core", "id": "def-server.SavedObjectsClient.find", "type": "Function", + "tags": [], "label": "find", + "description": [ + "\nFind all SavedObjects matching the search query\n" + ], "signature": [ "(options: ", { @@ -1888,15 +2105,19 @@ }, ">" ], - "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", @@ -1906,24 +2127,25 @@ "text": "SavedObjectsFindOptions" } ], - "description": [], "source": { "path": "src/core/server/saved_objects/service/saved_objects_client.ts", "lineNumber": 470 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "lineNumber": 469 - } + "returnComment": [] }, { + "parentPluginId": "core", "id": "def-server.SavedObjectsClient.bulkGet", "type": "Function", + "tags": [], "label": "bulkGet", + "description": [ + "\nReturns an array of objects by id\n" + ], "signature": [ "(objects?: ", { @@ -1951,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", @@ -1970,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": 487 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "core", "id": "def-server.SavedObjectsClient.bulkGet.$2", "type": "Object", + "tags": [], "label": "options", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "core", @@ -1992,24 +2221,25 @@ "text": "SavedObjectsBaseOptions" } ], - "description": [], "source": { "path": "src/core/server/saved_objects/service/saved_objects_client.ts", "lineNumber": 488 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "lineNumber": 486 - } + "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?: ", { @@ -2023,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": 501 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "core", "id": "def-server.SavedObjectsClient.get.$2", "type": "string", - "label": "id", - "isRequired": true, - "signature": [ - "string" - ], + "tags": [], + "label": "id", "description": [ "- The ID of the SavedObject to retrieve" ], + "signature": [ + "string" + ], "source": { "path": "src/core/server/saved_objects/service/saved_objects_client.ts", "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", @@ -2073,24 +2313,25 @@ "text": "SavedObjectsBaseOptions" } ], - "description": [], "source": { "path": "src/core/server/saved_objects/service/saved_objects_client.ts", "lineNumber": 503 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "lineNumber": 500 - } + "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?: ", { @@ -2110,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": 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": 517 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "core", "id": "def-server.SavedObjectsClient.resolve.$3", "type": "Object", + "tags": [], "label": "options", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "core", @@ -2160,24 +2411,25 @@ "text": "SavedObjectsBaseOptions" } ], - "description": [], "source": { "path": "src/core/server/saved_objects/service/saved_objects_client.ts", "lineNumber": 518 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "lineNumber": 515 - } + "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?: ", { @@ -2197,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": 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": 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": 533 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "core", "id": "def-server.SavedObjectsClient.update.$4", "type": "Object", + "tags": [], "label": "options", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "core", @@ -2258,24 +2523,25 @@ }, "" ], - "description": [], "source": { "path": "src/core/server/saved_objects/service/saved_objects_client.ts", "lineNumber": 534 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "lineNumber": 530 - } + "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?: ", { @@ -2295,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": 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": 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": 550 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "core", "id": "def-server.SavedObjectsClient.addToNamespaces.$4", "type": "Object", + "tags": [], "label": "options", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "core", @@ -2355,24 +2634,25 @@ "text": "SavedObjectsAddToNamespacesOptions" } ], - "description": [], "source": { "path": "src/core/server/saved_objects/service/saved_objects_client.ts", "lineNumber": 551 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "lineNumber": 547 - } + "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?: ", { @@ -2392,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": 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": 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": 567 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "core", "id": "def-server.SavedObjectsClient.deleteFromNamespaces.$4", "type": "Object", + "tags": [], "label": "options", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "core", @@ -2452,24 +2745,25 @@ "text": "SavedObjectsDeleteFromNamespacesOptions" } ], - "description": [], "source": { "path": "src/core/server/saved_objects/service/saved_objects_client.ts", "lineNumber": 568 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "lineNumber": 564 - } + "returnComment": [] }, { + "parentPluginId": "core", "id": "def-server.SavedObjectsClient.bulkUpdate", "type": "Function", + "tags": [], "label": "bulkUpdate", + "description": [ + "\nBulk Updates multiple SavedObject at once\n" + ], "signature": [ "(objects: ", { @@ -2497,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", @@ -2516,17 +2814,20 @@ }, "[]" ], - "description": [], "source": { "path": "src/core/server/saved_objects/service/saved_objects_client.ts", "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", @@ -2537,24 +2838,25 @@ }, " | undefined" ], - "description": [], "source": { "path": "src/core/server/saved_objects/service/saved_objects_client.ts", "lineNumber": 580 - } + }, + "deprecated": false, + "isRequired": false } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "lineNumber": 578 - } + "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?: ", { @@ -2574,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": 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": 590 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "core", "id": "def-server.SavedObjectsClient.removeReferencesTo.$3", "type": "Object", + "tags": [], "label": "options", - "isRequired": false, + "description": [], "signature": [ { "pluginId": "core", @@ -2621,24 +2933,25 @@ }, " | undefined" ], - "description": [], "source": { "path": "src/core/server/saved_objects/service/saved_objects_client.ts", "lineNumber": 591 - } + }, + "deprecated": false, + "isRequired": false } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "lineNumber": 588 - } + "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?: ", { @@ -2658,29 +2971,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 {@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": 605 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "core", "id": "def-server.SavedObjectsClient.openPointInTimeForType.$2", "type": "Object", + "tags": [], "label": "options", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "core", @@ -2690,24 +3010,25 @@ "text": "SavedObjectsOpenPointInTimeOptions" } ], - "description": [], "source": { "path": "src/core/server/saved_objects/service/saved_objects_client.ts", "lineNumber": 606 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "lineNumber": 604 - } + "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?: ", { @@ -2727,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": 619 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "core", "id": "def-server.SavedObjectsClient.closePointInTime.$2", "type": "Object", + "tags": [], "label": "options", - "isRequired": false, + "description": [], "signature": [ { "pluginId": "core", @@ -2760,24 +3088,25 @@ }, " | undefined" ], - "description": [], "source": { "path": "src/core/server/saved_objects/service/saved_objects_client.ts", "lineNumber": 619 - } + }, + "deprecated": false, + "isRequired": false } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "lineNumber": 619 - } + "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<", { @@ -2801,18 +3130,22 @@ "scope": "server", "docId": "kibCoreSavedObjectsPluginApi", "section": "def-server.ISavedObjectsPointInTimeFinder", - "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" + "text": "ISavedObjectsPointInTimeFinder" + } ], + "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<", { @@ -2824,17 +3157,20 @@ }, ", \"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": 669 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "core", "id": "def-server.SavedObjectsClient.createPointInTimeFinder.$2", "type": "Object", + "tags": [], "label": "dependencies", - "isRequired": false, + "description": [], "signature": [ { "pluginId": "core", @@ -2845,40 +3181,39 @@ }, " | undefined" ], - "description": [], "source": { "path": "src/core/server/saved_objects/service/saved_objects_client.ts", "lineNumber": 670 - } + }, + "deprecated": false, + "isRequired": false } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "lineNumber": 668 - } + "returnComment": [] } ], - "source": { - "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "lineNumber": 404 - }, "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 ", { @@ -2890,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 ", { @@ -2929,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 ", { @@ -2982,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 ", { @@ -3021,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 ", { @@ -3060,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 ", { @@ -3100,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 ", { @@ -3139,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 ", { @@ -3179,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 ", { @@ -3232,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 ", { @@ -3272,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 ", { @@ -3325,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 ", { @@ -3365,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 ", { @@ -3418,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 ", { @@ -3458,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 ", { @@ -3511,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 ", { @@ -3550,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 ", { @@ -3603,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 ", { @@ -3643,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 ", { @@ -3696,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 ", { @@ -3763,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 ", { @@ -3803,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 ", { @@ -3856,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 ", { @@ -3909,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 ", { @@ -3949,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 ", { @@ -4002,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 ", { @@ -4042,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 ", { @@ -4095,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 ", { @@ -4135,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 ", { @@ -4188,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<", { @@ -4249,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<", { @@ -4334,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<", { @@ -4356,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: ", { @@ -4414,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", @@ -4432,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: ", { @@ -4465,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", @@ -4483,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": [ @@ -4524,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 ", { @@ -4599,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 ", { @@ -4638,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 ", { @@ -4678,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 ", { @@ -4734,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<", { @@ -4796,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<", { @@ -4818,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<", { @@ -4889,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<", { @@ -4911,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, }: ", { @@ -4961,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", @@ -4979,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, }: ", { @@ -5018,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", @@ -5036,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": [ @@ -5077,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 ", { @@ -5093,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 ", { @@ -5132,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 ", { @@ -5171,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 ", { @@ -5210,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 ", { @@ -5249,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?: ", { @@ -5307,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": 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": 259 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "core", "id": "def-server.SavedObjectsRepository.create.$3", "type": "Object", + "tags": [], "label": "options", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "core", @@ -5353,28 +6010,30 @@ "text": "SavedObjectsCreateOptions" } ], - "description": [], "source": { "path": "src/core/server/saved_objects/service/lib/repository.ts", "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": 257 - } + ] }, { + "parentPluginId": "core", "id": "def-server.SavedObjectsRepository.bulkCreate", "type": "Function", + "tags": [ + "property", + "property" + ], "label": "bulkCreate", + "description": [ + "\nCreates multiple documents at once\n" + ], "signature": [ "(objects: ", { @@ -5402,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", @@ -5421,19 +6086,20 @@ }, "[]" ], - "description": [ - "- [{ type, id, attributes, references, migrationVersion }]" - ], "source": { "path": "src/core/server/saved_objects/service/lib/repository.ts", "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", @@ -5443,28 +6109,27 @@ "text": "SavedObjectsCreateOptions" } ], - "description": [], "source": { "path": "src/core/server/saved_objects/service/lib/repository.ts", "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": 350 - } + ] }, { + "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?: ", { @@ -5492,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", @@ -5511,17 +6180,20 @@ }, "[]" ], - "description": [], "source": { "path": "src/core/server/saved_objects/service/lib/repository.ts", "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", @@ -5531,24 +6203,27 @@ "text": "SavedObjectsBaseOptions" } ], - "description": [], "source": { "path": "src/core/server/saved_objects/service/lib/repository.ts", "lineNumber": 543 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/core/server/saved_objects/service/lib/repository.ts", - "lineNumber": 541 - } + "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?: ", { @@ -5560,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": 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": 628 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "core", "id": "def-server.SavedObjectsRepository.delete.$3", "type": "Object", + "tags": [], "label": "options", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "core", @@ -5606,26 +6291,25 @@ "text": "SavedObjectsDeleteOptions" } ], - "description": [], "source": { "path": "src/core/server/saved_objects/service/lib/repository.ts", "lineNumber": 628 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [ - "property" - ], - "returnComment": [], - "source": { - "path": "src/core/server/saved_objects/service/lib/repository.ts", - "lineNumber": 628 - } + "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?: ", { @@ -5637,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": 691 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "core", "id": "def-server.SavedObjectsRepository.deleteByNamespace.$2", "type": "Object", + "tags": [], "label": "options", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "core", @@ -5669,26 +6360,40 @@ "text": "SavedObjectsDeleteByNamespaceOptions" } ], - "description": [], "source": { "path": "src/core/server/saved_objects/service/lib/repository.ts", "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": 690 - } + ] }, { + "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: ", { @@ -5708,13 +6413,19 @@ }, ">" ], - "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", @@ -5724,28 +6435,29 @@ "text": "SavedObjectsFindOptions" } ], - "description": [], "source": { "path": "src/core/server/saved_objects/service/lib/repository.ts", "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": 752 - } + ] }, { + "parentPluginId": "core", "id": "def-server.SavedObjectsRepository.bulkGet", "type": "Function", + "tags": [ + "property" + ], "label": "bulkGet", + "description": [ + "\nReturns an array of objects by id\n" + ], "signature": [ "(objects?: ", { @@ -5773,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", @@ -5792,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": 920 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "core", "id": "def-server.SavedObjectsRepository.bulkGet.$2", "type": "Object", + "tags": [], "label": "options", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "core", @@ -5814,28 +6533,29 @@ "text": "SavedObjectsBaseOptions" } ], - "description": [], "source": { "path": "src/core/server/saved_objects/service/lib/repository.ts", "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": 919 - } + ] }, { + "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?: ", { @@ -5849,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": 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": 1008 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "core", "id": "def-server.SavedObjectsRepository.get.$3", "type": "Object", + "tags": [], "label": "options", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "core", @@ -5895,28 +6625,29 @@ "text": "SavedObjectsBaseOptions" } ], - "description": [], "source": { "path": "src/core/server/saved_objects/service/lib/repository.ts", "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": 1006 - } + ] }, { + "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?: ", { @@ -5936,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": 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": 1050 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "core", "id": "def-server.SavedObjectsRepository.resolve.$3", "type": "Object", + "tags": [], "label": "options", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "core", @@ -5982,28 +6723,31 @@ "text": "SavedObjectsBaseOptions" } ], - "description": [], "source": { "path": "src/core/server/saved_objects/service/lib/repository.ts", "lineNumber": 1051 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [ - "property" - ], "returnComment": [ "- { saved_object, outcome }" - ], - "source": { - "path": "src/core/server/saved_objects/service/lib/repository.ts", - "lineNumber": 1048 - } + ] }, { + "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?: ", { @@ -6023,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": 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": 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": 1176 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "core", "id": "def-server.SavedObjectsRepository.update.$4", "type": "Object", + "tags": [], "label": "options", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "core", @@ -6084,26 +6841,25 @@ }, "" ], - "description": [], "source": { "path": "src/core/server/saved_objects/service/lib/repository.ts", "lineNumber": 1177 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [ - "property" - ], - "returnComment": [], - "source": { - "path": "src/core/server/saved_objects/service/lib/repository.ts", - "lineNumber": 1173 - } + "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?: ", { @@ -6123,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": 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": 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": 1273 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "core", "id": "def-server.SavedObjectsRepository.addToNamespaces.$4", "type": "Object", + "tags": [], "label": "options", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "core", @@ -6183,24 +6952,25 @@ "text": "SavedObjectsAddToNamespacesOptions" } ], - "description": [], "source": { "path": "src/core/server/saved_objects/service/lib/repository.ts", "lineNumber": 1274 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/core/server/saved_objects/service/lib/repository.ts", - "lineNumber": 1270 - } + "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?: ", { @@ -6220,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": 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": 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": 1336 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "core", "id": "def-server.SavedObjectsRepository.deleteFromNamespaces.$4", "type": "Object", + "tags": [], "label": "options", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "core", @@ -6280,24 +7063,28 @@ "text": "SavedObjectsDeleteFromNamespacesOptions" } ], - "description": [], "source": { "path": "src/core/server/saved_objects/service/lib/repository.ts", "lineNumber": 1337 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/core/server/saved_objects/service/lib/repository.ts", - "lineNumber": 1333 - } + "returnComment": [] }, { + "parentPluginId": "core", "id": "def-server.SavedObjectsRepository.bulkUpdate", "type": "Function", + "tags": [ + "property", + "property" + ], "label": "bulkUpdate", + "description": [ + "\nUpdates multiple objects in bulk\n" + ], "signature": [ "(objects: ", { @@ -6325,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", @@ -6344,19 +7137,20 @@ }, "[]" ], - "description": [ - "- [{ type, id, attributes, options: { version, namespace } references }]" - ], "source": { "path": "src/core/server/saved_objects/service/lib/repository.ts", "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", @@ -6366,28 +7160,27 @@ "text": "SavedObjectsBulkUpdateOptions" } ], - "description": [], "source": { "path": "src/core/server/saved_objects/service/lib/repository.ts", "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": 1439 - } + ] }, { + "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?: ", { @@ -6407,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": 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": 1660 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "core", "id": "def-server.SavedObjectsRepository.removeReferencesTo.$3", "type": "Object", + "tags": [], "label": "options", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "core", @@ -6453,24 +7256,25 @@ "text": "SavedObjectsRemoveReferencesToOptions" } ], - "description": [], "source": { "path": "src/core/server/saved_objects/service/lib/repository.ts", "lineNumber": 1661 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/core/server/saved_objects/service/lib/repository.ts", - "lineNumber": 1658 - } + "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 | ", { @@ -6492,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": 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": 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 | ", { @@ -6544,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": 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", @@ -6567,28 +7386,30 @@ }, "" ], - "description": [ - "- {@link SavedObjectsIncrementCounterOptions}" - ], "source": { "path": "src/core/server/saved_objects/service/lib/repository.ts", "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": 1769 - } + ] }, { + "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 }?: ", { @@ -6608,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": 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", @@ -6640,28 +7468,27 @@ "text": "SavedObjectsOpenPointInTimeOptions" } ], - "description": [], "source": { "path": "src/core/server/saved_objects/service/lib/repository.ts", "lineNumber": 1931 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [ - "property" - ], "returnComment": [ "- { id: string }" - ], - "source": { - "path": "src/core/server/saved_objects/service/lib/repository.ts", - "lineNumber": 1929 - } + ] }, { + "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?: ", { @@ -6681,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": 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", @@ -6714,28 +7550,27 @@ }, " | undefined" ], - "description": [ - "- {@link SavedObjectsClosePointInTimeOptions}" - ], "source": { "path": "src/core/server/saved_objects/service/lib/repository.ts", "lineNumber": 2004 - } + }, + "deprecated": false, + "isRequired": false } ], - "tags": [], "returnComment": [ "- {@link SavedObjectsClosePointInTimeResponse}" - ], - "source": { - "path": "src/core/server/saved_objects/service/lib/repository.ts", - "lineNumber": 2002 - } + ] }, { + "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<", { @@ -6762,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<", { @@ -6782,17 +7621,20 @@ }, ", \"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": 2059 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "core", "id": "def-server.SavedObjectsRepository.createPointInTimeFinder.$2", "type": "Object", + "tags": [], "label": "dependencies", - "isRequired": false, + "description": [], "signature": [ { "pluginId": "core", @@ -6803,42 +7645,43 @@ }, " | undefined" ], - "description": [], "source": { "path": "src/core/server/saved_objects/service/lib/repository.ts", "lineNumber": 2060 - } + }, + "deprecated": false, + "isRequired": false } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/core/server/saved_objects/service/lib/repository.ts", - "lineNumber": 2058 - } + "returnComment": [] } ], - "source": { - "path": "src/core/server/saved_objects/service/lib/repository.ts", - "lineNumber": 159 - }, "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: ", { @@ -6858,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", @@ -6876,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", @@ -6898,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: ", { @@ -6945,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", @@ -6963,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": 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", @@ -6985,26 +7845,25 @@ "text": "SavedObjectsRawDocParseOptions" } ], - "description": [ - "- Options for parsing the raw document." - ], "source": { "path": "src/core/server/saved_objects/serialization/serializer.ts", "lineNumber": 81 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/core/server/saved_objects/serialization/serializer.ts", - "lineNumber": 79 - } + "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: ", { @@ -7023,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", @@ -7042,262 +7907,272 @@ }, "" ], - "description": [ - "- The saved object to be converted to raw ES format." - ], "source": { "path": "src/core/server/saved_objects/serialization/serializer.ts", "lineNumber": 125 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/core/server/saved_objects/serialization/serializer.ts", - "lineNumber": 125 - } + "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": 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": 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": 166 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/core/server/saved_objects/serialization/serializer.ts", - "lineNumber": 166 - } + "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": 179 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "core", "id": "def-server.SavedObjectsSerializer.generateRawLegacyUrlAliasId.$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": 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": 179 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/core/server/saved_objects/serialization/serializer.ts", - "lineNumber": 179 - } + "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, }: ", @@ -7318,21 +8193,47 @@ }, "" ], - "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 ", { @@ -7344,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 ", { @@ -7370,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: ", { @@ -7433,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", @@ -7451,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) => ", { @@ -7480,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": [ "() => ", { @@ -7521,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": [ "() => ", { @@ -7547,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": [ "() => ", { @@ -7573,279 +8495,308 @@ }, "[]" ], - "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<", { @@ -7856,52 +8807,56 @@ "text": "SavedObjectsFindResponse" }, ", 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", @@ -7911,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", @@ -7999,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" @@ -8012,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", @@ -8090,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": 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": 229 }, - "signature": [ - "boolean | \"wait_for\" | undefined" - ] + "deprecated": false } ], - "source": { - "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "lineNumber": 225 - }, "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": 238 }, - "signature": [ - "string[]" - ] + "deprecated": false } ], - "source": { - "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "lineNumber": 236 - }, "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": 164 }, - "signature": [ - "string | undefined" - ] + "deprecated": false } ], - "source": { - "path": "src/core/server/saved_objects/types.ts", - "lineNumber": 162 - }, "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-server.SavedObjectsBulkCreateObject", "type": "Interface", + "tags": [], "label": "SavedObjectsBulkCreateObject", + "description": [ + "\n" + ], "signature": [ { "pluginId": "core", @@ -8218,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": 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": 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": 305 }, - "signature": [ - "string[] | undefined" - ] + "deprecated": false } ], - "source": { - "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "lineNumber": 301 - }, "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-server.SavedObjectsBulkResponse", "type": "Interface", + "tags": [], "label": "SavedObjectsBulkResponse", + "description": [ + "\n" + ], "signature": [ { "pluginId": "core", @@ -8435,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", @@ -8478,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": [], + "signature": [ + "SavedObject", + "[]" + ], "source": { "path": "src/core/server/saved_objects/service/saved_objects_client.ts", "lineNumber": 313 }, - "signature": [ - "SavedObject", - "[]" - ] + "deprecated": false } ], - "source": { - "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "lineNumber": 312 - }, "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-server.SavedObjectsBulkUpdateObject", "type": "Interface", + "tags": [], "label": "SavedObjectsBulkUpdateObject", + "description": [ + "\n" + ], "signature": [ { "pluginId": "core", @@ -8529,17 +9540,17 @@ }, ", \"version\" | \"references\">" ], - "description": [ - "\n" - ], - "tags": [ - "public" - ], + "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`" @@ -8547,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." @@ -8560,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", @@ -8622,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": 283 }, - "signature": [ - "boolean | \"wait_for\" | undefined" - ] + "deprecated": false } ], - "source": { - "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "lineNumber": 281 - }, "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-server.SavedObjectsBulkUpdateResponse", "type": "Interface", + "tags": [], "label": "SavedObjectsBulkUpdateResponse", + "description": [ + "\n" + ], "signature": [ { "pluginId": "core", @@ -8666,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": 321 - }, "signature": [ { "pluginId": "core", @@ -8692,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": 320 - }, "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": 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": 191 - } + }, + "deprecated": false } ], - "source": { - "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "lineNumber": 189 - }, "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": 199 - }, "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": 198 - }, "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<", { @@ -8852,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<", { @@ -8874,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", @@ -8895,28 +9928,34 @@ "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." @@ -8924,12 +9963,14 @@ "source": { "path": "src/core/server/saved_objects/service/saved_objects_client.ts", "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." @@ -8937,94 +9978,100 @@ "source": { "path": "src/core/server/saved_objects/service/saved_objects_client.ts", "lineNumber": 397 - } + }, + "deprecated": false } ], - "source": { - "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "lineNumber": 388 - }, "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", @@ -9033,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", @@ -9148,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", @@ -9365,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": 134 }, - "signature": [ - "boolean | undefined" - ] + "deprecated": false } ], - "source": { - "path": "src/core/server/saved_objects/service/lib/repository.ts", - "lineNumber": 132 - }, "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-server.SavedObjectsDeleteFromNamespacesOptions", "type": "Interface", + "tags": [], "label": "SavedObjectsDeleteFromNamespacesOptions", + "description": [ + "\n" + ], "signature": [ { "pluginId": "core", @@ -9416,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": 247 }, - "signature": [ - "boolean | \"wait_for\" | undefined" - ] + "deprecated": false } ], - "source": { - "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "lineNumber": 245 - }, "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": 256 }, - "signature": [ - "string[]" - ] + "deprecated": false } ], - "source": { - "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "lineNumber": 254 - }, "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-server.SavedObjectsDeleteOptions", "type": "Interface", + "tags": [], "label": "SavedObjectsDeleteOptions", + "description": [ + "\n" + ], "signature": [ { "pluginId": "core", @@ -9501,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": 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": 294 }, - "signature": [ - "boolean | undefined" - ] + "deprecated": false } ], - "source": { - "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "lineNumber": 290 - }, "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", @@ -9568,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", @@ -9619,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 - }, + "description": [ + "optional array of references to search object for." + ], "signature": [ { "pluginId": "core", @@ -9663,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" @@ -9710,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" @@ -9723,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", @@ -9780,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", @@ -9979,132 +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 }, - "signature": [ - "any" - ] + "deprecated": false }, { + "parentPluginId": "core", + "id": "def-server.SavedObjectsFindOptions.aggs", + "type": "Object", "tags": [ "alpha" ], - "id": "def-server.SavedObjectsFindOptions.aggs", - "type": "Object", "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" ], - "source": { - "path": "src/core/server/saved_objects/types.ts", - "lineNumber": 140 - }, "signature": [ "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": 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": 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": 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": 155 - }, "signature": [ { "pluginId": "core", @@ -10114,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", @@ -10175,37 +11326,35 @@ }, "" ], - "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": [ { - "tags": [], + "parentPluginId": "core", "id": "def-server.SavedObjectsFindResponse.aggregations", "type": "Uncategorized", + "tags": [], "label": "aggregations", "description": [], + "signature": [ + "A | undefined" + ], "source": { "path": "src/core/server/saved_objects/service/saved_objects_client.ts", "lineNumber": 177 }, - "signature": [ - "A | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-server.SavedObjectsFindResponse.saved_objects", "type": "Array", + "tags": [], "label": "saved_objects", "description": [], - "source": { - "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "lineNumber": 178 - }, "signature": [ { "pluginId": "core", @@ -10215,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": 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": 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": 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": 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", @@ -10287,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." @@ -10305,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." @@ -10366,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." @@ -10379,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", @@ -10625,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", @@ -10666,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." @@ -10759,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`." @@ -10788,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", @@ -10849,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", @@ -10870,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", @@ -10891,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" @@ -11049,216 +12285,254 @@ "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." @@ -11266,35 +12540,37 @@ "source": { "path": "src/core/server/saved_objects/service/lib/repository.ts", "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": 153 }, - "signature": [ - "number | undefined" - ] + "deprecated": false } ], - "source": { - "path": "src/core/server/saved_objects/service/lib/repository.ts", - "lineNumber": 149 - }, "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-server.SavedObjectsIncrementCounterOptions", "type": "Interface", + "tags": [], "label": "SavedObjectsIncrementCounterOptions", + "description": [], "signature": [ { "pluginId": "core", @@ -11312,211 +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": 114 }, - "signature": [ - "boolean | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-server.SavedObjectsIncrementCounterOptions.migrationVersion", "type": "Object", + "tags": [], "label": "migrationVersion", "description": [ "{@link SavedObjectsMigrationVersion}" ], + "signature": [ + "SavedObjectsMigrationVersion", + " | undefined" + ], "source": { "path": "src/core/server/saved_objects/service/lib/repository.ts", "lineNumber": 116 }, - "signature": [ - "SavedObjectsMigrationVersion", - " | undefined" - ] + "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": 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": 125 }, - "signature": [ - "Attributes | undefined" - ] + "deprecated": false } ], - "source": { - "path": "src/core/server/saved_objects/service/lib/repository.ts", - "lineNumber": 108 - }, "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": [], - "source": { - "path": "src/core/server/saved_objects/migrations/core/migration_logger.ts", - "lineNumber": 27 - }, "signature": [ "(msg: string, meta: Meta) => void" - ] + ], + "source": { + "path": "src/core/server/saved_objects/migrations/core/migration_logger.ts", + "lineNumber": 27 + }, + "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", @@ -11534,63 +12860,69 @@ "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": 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": 367 }, - "signature": [ - "string | undefined" - ] + "deprecated": false } ], - "source": { - "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "lineNumber": 359 - }, "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." @@ -11598,165 +12930,181 @@ "source": { "path": "src/core/server/saved_objects/service/saved_objects_client.ts", "lineNumber": 377 - } + }, + "deprecated": false } ], - "source": { - "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "lineNumber": 373 - }, "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`." ], - "source": { - "path": "src/core/server/saved_objects/serialization/types.ts", - "lineNumber": 86 - }, "signature": [ "\"strict\" | \"lax\" | undefined" - ] + ], + "source": { + "path": "src/core/server/saved_objects/serialization/types.ts", + "lineNumber": 86 + }, + "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", @@ -11774,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": 265 }, - "signature": [ - "boolean | undefined" - ] + "deprecated": false } ], - "source": { - "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "lineNumber": 263 - }, "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-server.SavedObjectsRemoveReferencesToResponse", "type": "Interface", + "tags": [], "label": "SavedObjectsRemoveReferencesToResponse", + "description": [ + "\n" + ], "signature": [ { "pluginId": "core", @@ -11825,17 +13175,17 @@ "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" @@ -11843,38 +13193,36 @@ "source": { "path": "src/core/server/saved_objects/service/saved_objects_client.ts", "lineNumber": 274 - } + }, + "deprecated": false } ], - "source": { - "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "lineNumber": 272 - }, "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: ", { @@ -11893,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<", { @@ -11917,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", @@ -11974,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`." @@ -12003,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", @@ -12026,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": [], + "signature": [ + "SavedObject", + "" + ], "source": { "path": "src/core/server/saved_objects/service/saved_objects_client.ts", "lineNumber": 339 }, - "signature": [ - "SavedObject", - "" - ] + "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": 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": 353 }, - "signature": [ - "string | undefined" - ] + "deprecated": false } ], - "source": { - "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "lineNumber": 338 - }, "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: ", { @@ -12120,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: ", { @@ -12144,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: ", { @@ -12168,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: ", { @@ -12226,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: ", { @@ -12258,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 - }, "signature": [ "(includedHiddenTypes?: string[] | undefined) => Pick<", { @@ -12282,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 - }, + "description": [ + "\nCreates a {@link SavedObjectsSerializer | serializer} that is aware of all registered types." + ], "signature": [ "() => ", { @@ -12305,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<", { @@ -12337,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<", { @@ -12369,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<", { @@ -12393,60 +13777,68 @@ "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." @@ -12454,12 +13846,14 @@ "source": { "path": "src/core/server/saved_objects/types.ts", "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}." @@ -12467,20 +13861,18 @@ "source": { "path": "src/core/server/saved_objects/types.ts", "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": 271 - }, "signature": [ { "pluginId": "core", @@ -12489,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": 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": 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": 283 - }, "signature": [ { "pluginId": "core", @@ -12543,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": 287 - }, "signature": [ { "pluginId": "core", @@ -12574,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": 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": 340 - }, "signature": [ { "pluginId": "core", @@ -12613,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": 256 - }, "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": 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": 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": 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": 366 - }, "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": 371 - }, "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": 380 - }, "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": 391 - }, "signature": [ { "pluginId": "core", @@ -12756,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": 434 - }, "signature": [ { "pluginId": "core", @@ -12779,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": 348 - }, "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", @@ -12835,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", @@ -12865,89 +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": 212 }, - "signature": [ - "string | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-server.SavedObjectsUpdateOptions.references", "type": "Array", + "tags": [], "label": "references", "description": [ "{@inheritdoc SavedObjectReference}" ], + "signature": [ + "SavedObjectReference", + "[] | undefined" + ], "source": { "path": "src/core/server/saved_objects/service/saved_objects_client.ts", "lineNumber": 214 }, - "signature": [ - "SavedObjectReference", - "[] | undefined" - ] + "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": 216 }, - "signature": [ - "boolean | \"wait_for\" | undefined" - ] + "deprecated": false }, { - "tags": [], + "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": [ + "Attributes | undefined" + ], "source": { "path": "src/core/server/saved_objects/service/saved_objects_client.ts", "lineNumber": 218 }, - "signature": [ - "Attributes | undefined" - ] + "deprecated": false } ], - "source": { - "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "lineNumber": 210 - }, "initialIsOpen": false }, { + "parentPluginId": "core", "id": "def-server.SavedObjectsUpdateResponse", "type": "Interface", + "tags": [], "label": "SavedObjectsUpdateResponse", + "description": [ + "\n" + ], "signature": [ { "pluginId": "core", @@ -12960,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": 330 }, - "signature": [ - "Partial" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "core", "id": "def-server.SavedObjectsUpdateResponse.references", "type": "Array", + "tags": [], "label": "references", "description": [], + "signature": [ + "SavedObjectReference", + "[] | undefined" + ], "source": { "path": "src/core/server/saved_objects/service/saved_objects_client.ts", "lineNumber": 331 }, - "signature": [ - "SavedObjectReference", - "[] | undefined" - ] + "deprecated": false } ], - "source": { - "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "lineNumber": 328 - }, "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", @@ -13025,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": 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" ], + "signature": [ + "false | true | \"wait_for\"" + ], "source": { "path": "src/core/server/saved_objects/types.ts", "lineNumber": 171 }, - "signature": [ - "false | true | \"wait_for\"" - ], + "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: ", { @@ -13142,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": 235 - }, "signature": [ "{ get: (type: string, id: string, options?: SavedObjectsBaseOptions) => Promise>; delete: (type: string, id: string, options?: ", { @@ -13219,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: ", { @@ -13254,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: ", { @@ -13288,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: ", { @@ -13323,37 +14755,37 @@ }, ", \"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": [], + "signature": [ + "SavedObjectsBaseOptions" + ], "source": { "path": "src/core/server/saved_objects/service/saved_objects_client.ts", "lineNumber": 383 }, - "signature": [ - "SavedObjectsBaseOptions" - ], + "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; 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?: ", { @@ -13373,22 +14805,22 @@ }, "[] | 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: ", { @@ -13406,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", @@ -13439,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", @@ -13476,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", @@ -13509,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" ], + "signature": [ + "\"multiple\" | \"single\" | \"multiple-isolated\" | \"agnostic\"" + ], "source": { "path": "src/core/server/saved_objects/types.ts", "lineNumber": 249 }, - "signature": [ - "\"multiple\" | \"single\" | \"multiple-isolated\" | \"agnostic\"" - ], + "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 bf891406a6339..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,65 +725,86 @@ "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": 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": 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", ">" ], - "description": [], "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", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "embeddable", @@ -722,56 +814,59 @@ "text": "EmbeddablePersistableStateService" } ], - "description": [], "source": { "path": "src/plugins/dashboard/public/application/embeddable/dashboard_container_factory.tsx", "lineNumber": 42 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/dashboard/public/application/embeddable/dashboard_container_factory.tsx", - "lineNumber": 40 - } + "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": 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": 50 }, - "tags": [], + "deprecated": false, + "children": [], "returnComment": [] }, { + "parentPluginId": "dashboard", "id": "def-public.DashboardContainerFactoryDefinition.getDefaultInput", "type": "Function", + "tags": [], "label": "getDefaultInput", + "description": [], "signature": [ "() => Partial<", { @@ -783,24 +878,76 @@ }, ">" ], - "description": [], - "children": [], - "tags": [], - "returnComment": [], "source": { "path": "src/plugins/dashboard/public/application/embeddable/dashboard_container_factory.tsx", "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", @@ -810,17 +957,20 @@ "text": "DashboardContainerInput" } ], - "description": [], "source": { "path": "src/plugins/dashboard/public/application/embeddable/dashboard_container_factory.tsx", "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", @@ -847,74 +997,23 @@ }, "> | undefined" ], - "description": [], "source": { "path": "src/plugins/dashboard/public/application/embeddable/dashboard_container_factory.tsx", "lineNumber": 68 - } - } - ], - "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" + }, + "deprecated": false, + "isRequired": false } ], - "description": [], - "label": "create", - "source": { - "path": "src/plugins/dashboard/public/application/embeddable/dashboard_container_factory.tsx", - "lineNumber": 66 - }, - "tags": [], "returnComment": [] }, { - "tags": [], + "parentPluginId": "dashboard", "id": "def-public.DashboardContainerFactoryDefinition.inject", "type": "Function", + "tags": [], "label": "inject", "description": [], - "source": { - "path": "src/plugins/dashboard/public/application/embeddable/dashboard_container_factory.tsx", - "lineNumber": 74 - }, "signature": [ "(state: ", { @@ -934,18 +1033,20 @@ "section": "def-common.EmbeddableStateWithType", "text": "EmbeddableStateWithType" } - ] + ], + "source": { + "path": "src/plugins/dashboard/public/application/embeddable/dashboard_container_factory.tsx", + "lineNumber": 74 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "dashboard", "id": "def-public.DashboardContainerFactoryDefinition.extract", "type": "Function", + "tags": [], "label": "extract", "description": [], - "source": { - "path": "src/plugins/dashboard/public/application/embeddable/dashboard_container_factory.tsx", - "lineNumber": 76 - }, "signature": [ "(state: ", { @@ -966,90 +1067,79 @@ "; references: ", "SavedObjectReference", "[]; }" - ] + ], + "source": { + "path": "src/plugins/dashboard/public/application/embeddable/dashboard_container_factory.tsx", + "lineNumber": 76 + }, + "deprecated": false } ], - "source": { - "path": "src/plugins/dashboard/public/application/embeddable/dashboard_container_factory.tsx", - "lineNumber": 34 - }, "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: ", { @@ -1069,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", @@ -1103,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", @@ -1140,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", @@ -1199,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", @@ -1258,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", @@ -1279,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", @@ -1310,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", @@ -1334,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": 92 - } + }, + "deprecated": false } ], - "source": { - "path": "src/plugins/dashboard/public/plugin.tsx", - "lineNumber": 91 - }, "initialIsOpen": false }, { + "parentPluginId": "dashboard", "id": "def-public.DashboardSavedObject", "type": "Interface", + "tags": [], "label": "DashboardSavedObject", + "description": [], "signature": [ { "pluginId": "dashboard", @@ -1389,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", @@ -1528,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<", { @@ -1550,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": [ "() => ", { @@ -1565,20 +1745,22 @@ "section": "def-common.Query", "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": [ "() => ", { @@ -1590,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", @@ -1664,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", @@ -1687,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", @@ -1710,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", @@ -1733,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", @@ -1788,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", @@ -1827,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": [], + "signature": [ + "UrlGeneratorContract<\"DASHBOARD_APP_URL_GENERATOR\">" + ], "source": { "path": "src/plugins/dashboard/public/plugin.tsx", "lineNumber": 89 }, - "signature": [ - "UrlGeneratorContract<\"DASHBOARD_APP_URL_GENERATOR\">" - ], + "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": 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": [], + "signature": [ + "void" + ], "source": { "path": "src/plugins/dashboard/public/plugin.tsx", "lineNumber": 123 }, - "signature": [ - "void" - ], + "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": 126 - }, "signature": [ "() => ", { @@ -2064,32 +2298,36 @@ "section": "def-public.SavedObjectLoader", "text": "SavedObjectLoader" } - ] + ], + "source": { + "path": "src/plugins/dashboard/public/plugin.tsx", + "lineNumber": 126 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "dashboard", "id": "def-public.DashboardStart.getDashboardContainerByValueRenderer", "type": "Function", + "tags": [], "label": "getDashboardContainerByValueRenderer", "description": [], + "signature": [ + "() => React.FC" + ], "source": { "path": "src/plugins/dashboard/public/plugin.tsx", "lineNumber": 127 }, - "signature": [ - "() => React.FC" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "dashboard", "id": "def-public.DashboardStart.dashboardUrlGenerator", "type": "Object", + "tags": [], "label": "dashboardUrlGenerator", "description": [], - "source": { - "path": "src/plugins/dashboard/public/plugin.tsx", - "lineNumber": 130 - }, "signature": [ { "pluginId": "dashboard", @@ -2099,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": 131 - }, "signature": [ { "pluginId": "dashboard", @@ -2119,13 +2359,14 @@ "section": "def-public.DashboardFeatureFlagConfig", "text": "DashboardFeatureFlagConfig" } - ] + ], + "source": { + "path": "src/plugins/dashboard/public/plugin.tsx", + "lineNumber": 131 + }, + "deprecated": false } ], - "source": { - "path": "src/plugins/dashboard/public/plugin.tsx", - "lineNumber": 125 - }, "lifecycle": "start", "initialIsOpen": true } @@ -2134,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 } @@ -2201,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 } @@ -2233,9 +2486,12 @@ "classes": [], "functions": [ { + "parentPluginId": "dashboard", "id": "def-common.migratePanelsTo730", "type": "Function", + "tags": [], "label": "migratePanelsTo730", + "description": [], "signature": [ "(panels: (", "RawSavedDashboardPanelTo60", @@ -2254,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", @@ -2279,82 +2541,91 @@ "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", @@ -2372,19 +2643,19 @@ "text": "EmbeddableStateWithType" } ], - "description": [], - "tags": [], + "source": { + "path": "src/plugins/dashboard/common/types.ts", + "lineNumber": 91 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "dashboard", "id": "def-common.DashboardContainerStateWithType.panels", "type": "Object", + "tags": [], "label": "panels", "description": [], - "source": { - "path": "src/plugins/dashboard/common/types.ts", - "lineNumber": 92 - }, "signature": [ "{ [panelId: string]: ", "DashboardPanelState", @@ -2397,235 +2668,268 @@ "text": "EmbeddableInput" }, " & { [k: string]: unknown; }>; }" - ] + ], + "source": { + "path": "src/plugins/dashboard/common/types.ts", + "lineNumber": 92 + }, + "deprecated": false } ], - "source": { - "path": "src/plugins/dashboard/common/types.ts", - "lineNumber": 91 - }, "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; panelRefName?: string | undefined; }" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "dashboard", "id": "def-common.SavedDashboardPanel610", "type": "Type", - "label": "SavedDashboardPanel610", "tags": [], + "label": "SavedDashboardPanel610", "description": [], + "signature": [ + "Pick & { readonly id: string; readonly type: string; }" + ], "source": { "path": "src/plugins/dashboard/common/types.ts", "lineNumber": 64 }, - "signature": [ - "Pick & { readonly id: string; readonly type: string; }" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "dashboard", "id": "def-common.SavedDashboardPanel620", "type": "Type", - "label": "SavedDashboardPanel620", "tags": [], + "label": "SavedDashboardPanel620", "description": [], + "signature": [ + "Pick & { readonly id: string; readonly type: string; }" + ], "source": { "path": "src/plugins/dashboard/common/types.ts", "lineNumber": 56 }, - "signature": [ - "Pick & { readonly id: string; readonly type: string; }" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "dashboard", "id": "def-common.SavedDashboardPanel630", "type": "Type", - "label": "SavedDashboardPanel630", "tags": [], + "label": "SavedDashboardPanel630", "description": [], + "signature": [ + "Pick & { readonly id: string; readonly type: string; }" + ], "source": { "path": "src/plugins/dashboard/common/types.ts", "lineNumber": 48 }, - "signature": [ - "Pick & { readonly id: string; readonly type: string; }" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "dashboard", "id": "def-common.SavedDashboardPanel640To720", "type": "Type", - "label": "SavedDashboardPanel640To720", "tags": [], + "label": "SavedDashboardPanel640To720", "description": [], + "signature": [ + "Pick, \"title\" | \"panelIndex\" | \"gridData\" | \"version\" | \"embeddableConfig\"> & { readonly id: string; readonly type: string; }" + ], "source": { "path": "src/plugins/dashboard/common/types.ts", "lineNumber": 40 }, - "signature": [ - "Pick, \"title\" | \"panelIndex\" | \"gridData\" | \"version\" | \"embeddableConfig\"> & { readonly id: string; readonly type: string; }" - ], + "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": 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": [], + "signature": [ + "Pick & { readonly id: string; readonly type: string; }" + ], "source": { "path": "src/plugins/dashboard/common/types.ts", "lineNumber": 72 }, - "signature": [ - "Pick & { readonly id: string; readonly type: string; }" - ], + "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 7d6834e439d60..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": 66 - }, "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": 67 - }, "signature": [ { "pluginId": "data", @@ -1131,46 +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": 68 }, - "signature": [ - "string[] | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-public.AggConfigs.hierarchical", "type": "CompoundType", + "tags": [], "label": "hierarchical", "description": [], + "signature": [ + "boolean | undefined" + ], "source": { "path": "src/plugins/data/common/search/aggs/agg_configs.ts", "lineNumber": 69 }, - "signature": [ - "boolean | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-public.AggConfigs.aggs", "type": "Array", + "tags": [], "label": "aggs", "description": [], - "source": { - "path": "src/plugins/data/common/search/aggs/agg_configs.ts", - "lineNumber": 73 - }, "signature": [ { "pluginId": "data", @@ -1180,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", @@ -1205,17 +1364,20 @@ "text": "IndexPattern" } ], - "description": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_configs.ts", "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": 77 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "data", "id": "def-public.AggConfigs.Unnamed.$3", "type": "Object", + "tags": [], "label": "opts", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "data", @@ -1257,55 +1422,59 @@ "text": "AggConfigsOptions" } ], - "description": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_configs.ts", "lineNumber": 78 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/data/common/search/aggs/agg_configs.ts", - "lineNumber": 75 - } + "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": 91 - } + }, + "deprecated": false, + "isRequired": false } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/data/common/search/aggs/agg_configs.ts", - "lineNumber": 91 - } + "returnComment": [] }, { + "parentPluginId": "data", "id": "def-public.AggConfigs.setTimeRange", "type": "Function", + "tags": [], "label": "setTimeRange", + "description": [], "signature": [ "(timeRange: ", { @@ -1317,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", @@ -1333,24 +1508,23 @@ "text": "TimeRange" } ], - "description": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_configs.ts", "lineNumber": 95 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/data/common/search/aggs/agg_configs.ts", - "lineNumber": 95 - } + "returnComment": [] }, { + "parentPluginId": "data", "id": "def-public.AggConfigs.clone", "type": "Function", + "tags": [], "label": "clone", + "description": [], "signature": [ "({ enabledOnly }?: { enabledOnly?: boolean | undefined; }) => ", { @@ -1361,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": 113 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/data/common/search/aggs/agg_configs.ts", - "lineNumber": 113 - } + "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": 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": 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": 126 + "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", @@ -1515,42 +1710,41 @@ }, "[]" ], - "description": [ - "an AggConfigs instance" - ], "source": { "path": "src/plugins/data/common/search/aggs/agg_configs.ts", "lineNumber": 169 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/data/common/search/aggs/agg_configs.ts", - "lineNumber": 169 - } + "returnComment": [] }, { + "parentPluginId": "data", "id": "def-public.AggConfigs.toDsl", "type": "Function", + "tags": [], "label": "toDsl", + "description": [], "signature": [ "() => Record" ], - "description": [], - "children": [], - "tags": [], - "returnComment": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_configs.ts", "lineNumber": 181 - } + }, + "deprecated": false, + "children": [], + "returnComment": [] }, { + "parentPluginId": "data", "id": "def-public.AggConfigs.getAll", "type": "Function", + "tags": [], "label": "getAll", + "description": [], "signature": [ "() => ", { @@ -1562,19 +1756,21 @@ }, "[]" ], - "description": [], - "children": [], - "tags": [], - "returnComment": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_configs.ts", "lineNumber": 250 - } + }, + "deprecated": false, + "children": [], + "returnComment": [] }, { + "parentPluginId": "data", "id": "def-public.AggConfigs.byIndex", "type": "Function", + "tags": [], "label": "byIndex", + "description": [], "signature": [ "(index: number) => ", { @@ -1585,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": 254 - } + }, + "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.byId", "type": "Function", + "tags": [], "label": "byId", + "description": [], "signature": [ "(id: string) => ", { @@ -1624,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": 258 - } + }, + "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.byName", "type": "Function", + "tags": [], "label": "byName", + "description": [], "signature": [ "(name: string) => ", { @@ -1663,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": 262 - } + }, + "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.byType", "type": "Function", + "tags": [], "label": "byType", + "description": [], "signature": [ "(type: string) => ", { @@ -1702,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": 266 - } + }, + "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.byTypeName", "type": "Function", + "tags": [], "label": "byTypeName", + "description": [], "signature": [ "(type: string) => ", { @@ -1741,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": 270 - } + }, + "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.bySchemaName", "type": "Function", + "tags": [], "label": "bySchemaName", + "description": [], "signature": [ "(schema: string) => ", { @@ -1780,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": 274 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/data/common/search/aggs/agg_configs.ts", - "lineNumber": 274 - } + "returnComment": [] }, { + "parentPluginId": "data", "id": "def-public.AggConfigs.getRequestAggs", "type": "Function", + "tags": [], "label": "getRequestAggs", + "description": [], "signature": [ "() => ", { @@ -1819,19 +2045,21 @@ }, "[]" ], - "description": [], - "children": [], - "tags": [], - "returnComment": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_configs.ts", "lineNumber": 278 - } + }, + "deprecated": false, + "children": [], + "returnComment": [] }, { + "parentPluginId": "data", "id": "def-public.AggConfigs.getRequestAggById", "type": "Function", + "tags": [], "label": "getRequestAggById", + "description": [], "signature": [ "(id: string) => ", { @@ -1843,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": 292 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/data/common/search/aggs/agg_configs.ts", - "lineNumber": 292 - } + "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": [ "() => ", { @@ -1882,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": 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) => ", { @@ -1910,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": 321 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [ - "return" - ], - "returnComment": [], - "source": { - "path": "src/plugins/data/common/search/aggs/agg_configs.ts", - "lineNumber": 321 - } + "returnComment": [] }, { + "parentPluginId": "data", "id": "def-public.AggConfigs.onSearchRequestStart", "type": "Function", + "tags": [], "label": "onSearchRequestStart", + "description": [], "signature": [ "(searchSource: Pick<", { @@ -1963,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<", { @@ -1981,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": 330 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "data", "id": "def-public.AggConfigs.onSearchRequestStart.$2", "type": "Object", + "tags": [], "label": "options", - "isRequired": false, + "description": [], "signature": [ { "pluginId": "data", @@ -2002,28 +2251,21 @@ }, " | undefined" ], - "description": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_configs.ts", "lineNumber": 330 - } + }, + "deprecated": false, + "isRequired": false } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/data/common/search/aggs/agg_configs.ts", - "lineNumber": 330 - } + "returnComment": [] } ], - "source": { - "path": "src/plugins/data/common/search/aggs/agg_configs.ts", - "lineNumber": 65 - }, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-public.AggParamType", "type": "Class", "tags": [], @@ -2047,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": [], @@ -2157,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", @@ -2182,24 +2449,23 @@ }, "; }>; }>; autocomplete: Readonly<{} & { querySuggestions: Readonly<{} & { enabled: boolean; }>; valueSuggestions: Readonly<{} & { enabled: boolean; }>; }>; }>>" ], - "description": [], "source": { "path": "src/plugins/data/public/plugin.ts", "lineNumber": 70 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/data/public/plugin.ts", - "lineNumber": 70 - } + "returnComment": [] }, { + "parentPluginId": "data", "id": "def-public.DataPublicPlugin.setup", "type": "Function", + "tags": [], "label": "setup", + "description": [], "signature": [ "(core: ", { @@ -2230,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", @@ -2257,38 +2529,40 @@ }, ">" ], - "description": [], "source": { "path": "src/plugins/data/public/plugin.ts", "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": 81 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/data/public/plugin.ts", - "lineNumber": 79 - } + "returnComment": [] }, { + "parentPluginId": "data", "id": "def-public.DataPublicPlugin.start", "type": "Function", + "tags": [], "label": "start", + "description": [], "signature": [ "(core: ", { @@ -2309,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", @@ -2325,58 +2605,56 @@ "text": "CoreStart" } ], - "description": [], "source": { "path": "src/plugins/data/public/plugin.ts", "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": 127 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/data/public/plugin.ts", - "lineNumber": 127 - } + "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": 209 - } + }, + "deprecated": false, + "children": [], + "returnComment": [] } ], - "source": { - "path": "src/plugins/data/public/plugin.ts", - "lineNumber": 54 - }, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-public.DuplicateIndexPatternError", "type": "Class", "tags": [], @@ -2392,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", @@ -2603,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", @@ -2643,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?: ", { @@ -2674,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", @@ -2706,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?: ", { @@ -2759,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", @@ -2777,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 ", { @@ -2914,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 ", { @@ -2970,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": [], @@ -3024,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", @@ -3085,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", @@ -3114,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", @@ -3253,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" @@ -3266,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]: ", { @@ -3350,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": [ "() => ", { @@ -3397,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": [ "() => ", { @@ -3539,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": [ "() => ", { @@ -3563,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": [ "() => ", { @@ -3619,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) => ", { @@ -3643,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: ", { @@ -3739,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", @@ -3773,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: ", { @@ -3802,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", @@ -3836,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) => ", { @@ -3902,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: ", { @@ -3943,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", @@ -3988,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", @@ -4125,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": [], @@ -4213,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", @@ -4232,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", @@ -4257,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", @@ -4314,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", @@ -4335,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", @@ -4565,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: ", { @@ -4647,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: ", { @@ -4702,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: ", { @@ -4755,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 } ], - "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-public.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-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", - "children": [ - { + "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", @@ -5030,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<", { @@ -5054,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", @@ -5130,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", @@ -5146,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", @@ -5187,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", @@ -5208,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: ", { @@ -5224,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", @@ -5273,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 } ], + "returnComment": [] + }, + { + "parentPluginId": "data", + "id": "def-public.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-public.IndexPatternsService.fieldArrayToMap", - "type": "Function", + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-public.IndexPatternsService.fieldArrayToMap.$1", "type": "Array", + "tags": [], "label": "fields", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "data", @@ -5321,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", @@ -5342,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", "<", @@ -5410,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<", @@ -5480,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: ", { @@ -5514,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", @@ -5532,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: ", { @@ -5585,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", @@ -5603,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: ", { @@ -5672,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", @@ -5690,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: ", { @@ -5735,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", @@ -5753,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": [], @@ -5869,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", @@ -5889,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": 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", @@ -5975,17 +6689,20 @@ "text": "SearchSourceFields" } ], - "description": [], "source": { "path": "src/plugins/data/common/search/search_source/search_source.ts", "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", @@ -5995,57 +6712,63 @@ "text": "SearchSourceDependencies" } ], - "description": [], "source": { "path": "src/plugins/data/common/search/search_source/search_source.ts", "lineNumber": 133 - } + }, + "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.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": 151 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/data/common/search/search_source/search_source.ts", - "lineNumber": 151 - } + "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: ", { @@ -6057,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": 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", @@ -6092,61 +6824,67 @@ }, "[K]" ], - "description": [ - ": value for the field" - ], "source": { "path": "src/plugins/data/common/search/search_source/search_source.ts", "lineNumber": 160 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/data/common/search/search_source/search_source.ts", - "lineNumber": 160 - } + "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": 172 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/data/common/search/search_source/search_source.ts", - "lineNumber": 172 - } + "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: ", { @@ -6158,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", @@ -6176,46 +6920,45 @@ "text": "SearchSourceFields" } ], - "description": [ - "New field array." - ], "source": { "path": "src/plugins/data/common/search/search_source/search_source.ts", "lineNumber": 183 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [ - "private" - ], - "returnComment": [], - "source": { - "path": "src/plugins/data/common/search/search_source/search_source.ts", - "lineNumber": 183 - } + "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": 191 - } + }, + "deprecated": false, + "children": [], + "returnComment": [] }, { + "parentPluginId": "data", "id": "def-public.SearchSource.getFields", "type": "Function", + "tags": [], "label": "getFields", + "description": [ + "\nreturns all search source fields" + ], "signature": [ "() => ", { @@ -6226,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": 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) => ", { @@ -6252,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": 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": 205 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/data/common/search/search_source/search_source.ts", - "lineNumber": 205 - } + "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) => ", { @@ -6307,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": 216 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/data/common/search/search_source/search_source.ts", - "lineNumber": 216 - } + "returnComment": [] }, { + "parentPluginId": "data", "id": "def-public.SearchSource.create", "type": "Function", + "tags": [ + "deprecated" + ], "label": "create", + "description": [], "signature": [ "() => ", { @@ -6347,21 +7105,39 @@ "text": "SearchSource" } ], - "description": [], - "children": [], - "tags": [ - "deprecated" - ], - "returnComment": [], "source": { "path": "src/plugins/data/common/search/search_source/search_source.ts", "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": [ "() => ", { @@ -6372,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": 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?: {}) => ", { @@ -6397,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": 244 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/data/common/search/search_source/search_source.ts", - "lineNumber": 244 - } + "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<", { @@ -6446,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<", { @@ -6466,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": 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", @@ -6488,30 +7282,29 @@ "text": "SearchSourceOptions" } ], - "description": [ - "- the inherit options" - ], "source": { "path": "src/plugins/data/common/search/search_source/search_source.ts", "lineNumber": 256 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [ - "return" - ], "returnComment": [ "- chainable" - ], - "source": { - "path": "src/plugins/data/common/search/search_source/search_source.ts", - "lineNumber": 256 - } + ] }, { + "parentPluginId": "data", "id": "def-public.SearchSource.getParent", "type": "Function", + "tags": [ + "return" + ], "label": "getParent", + "description": [ + "\nGet the parent of this SearchSource" + ], "signature": [ "() => ", { @@ -6523,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": 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?: ", { @@ -6563,15 +7356,19 @@ "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", @@ -6581,24 +7378,27 @@ "text": "ISearchOptions" } ], - "description": [], "source": { "path": "src/plugins/data/common/search/search_source/search_source.ts", "lineNumber": 275 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/data/common/search/search_source/search_source.ts", - "lineNumber": 274 - } + "returnComment": [] }, { + "parentPluginId": "data", "id": "def-public.SearchSource.fetch", "type": "Function", + "tags": [ + "deprecated" + ], "label": "fetch", + "description": [ + "\nFetch this source and reject the returned Promise on error" + ], "signature": [ "(options?: ", { @@ -6612,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", @@ -6630,26 +7471,27 @@ "text": "ISearchOptions" } ], - "description": [], "source": { "path": "src/plugins/data/common/search/search_source/search_source.ts", "lineNumber": 312 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [ - "deprecated" - ], - "returnComment": [], - "source": { - "path": "src/plugins/data/common/search/search_source/search_source.ts", - "lineNumber": 312 - } + "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: ", { @@ -6669,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: ", { @@ -6697,64 +7543,67 @@ }, " | undefined) => Promise" ], - "description": [], "source": { "path": "src/plugins/data/common/search/search_source/search_source.ts", "lineNumber": 326 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [ - "return" - ], - "returnComment": [], - "source": { - "path": "src/plugins/data/common/search/search_source/search_source.ts", - "lineNumber": 325 - } + "returnComment": [] }, { + "parentPluginId": "data", "id": "def-public.SearchSource.getSearchRequestBody", "type": "Function", + "tags": [], "label": "getSearchRequestBody", - "signature": [ - "() => any" - ], "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": 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": 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) => ", { @@ -6765,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": 826 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/data/common/search/search_source/search_source.ts", - "lineNumber": 826 - } + "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": 855 - } + }, + "deprecated": false, + "children": [], + "returnComment": [] } ], - "source": { - "path": "src/plugins/data/common/search/search_source/search_source.ts", - "lineNumber": 121 - }, "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) => ", @@ -6851,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: ", { @@ -6911,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", @@ -6940,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: ", { @@ -7032,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", @@ -7073,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: ", { @@ -7123,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", @@ -7140,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", @@ -7160,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", @@ -7235,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", @@ -7306,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?: ", { @@ -7322,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", @@ -7355,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" ], "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 ", { @@ -7414,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 ", { @@ -7454,42 +8351,40 @@ }, "[]" ], - "description": [], - "label": "isFilters", "source": { "path": "src/plugins/data/common/es_query/filters/meta_filter.ts", "lineNumber": 110 }, - "tags": [], - "returnComment": [], - "initialIsOpen": false - }, - { - "id": "def-public.isPartialResponse", - "type": "Function", + "deprecated": false, "children": [ { - "id": "def-public.isPartialResponse.$1", - "type": "Object", - "label": "response", - "isRequired": false, - "signature": [ - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.IKibanaSearchResponse", - "text": "IKibanaSearchResponse" - }, - " | undefined" - ], + "parentPluginId": "data", + "id": "def-public.isFilters.$1", + "type": "Unknown", + "tags": [], + "label": "x", "description": [], + "signature": [ + "unknown" + ], "source": { - "path": "src/plugins/data/common/search/utils.ts", - "lineNumber": 28 - } + "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?: ", { @@ -7501,37 +8396,49 @@ }, " | undefined) => boolean" ], - "description": [], - "label": "isPartialResponse", "source": { "path": "src/plugins/data/common/search/utils.ts", "lineNumber": 28 }, - "tags": [], + "deprecated": false, + "children": [ + { + "parentPluginId": "data", + "id": "def-public.isPartialResponse.$1", + "type": "Object", + "tags": [], + "label": "response", + "description": [], + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.IKibanaSearchResponse", + "text": "IKibanaSearchResponse" + }, + " | undefined" + ], + "source": { + "path": "src/plugins/data/common/search/utils.ts", + "lineNumber": 28 + }, + "deprecated": false, + "isRequired": false + } + ], "returnComment": [ "true if request is still running an/d response contains partial results" ], "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-public.isQuery", "type": "Function", - "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 ", { @@ -7542,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 ", { @@ -7581,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) => ", { @@ -7620,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": [], + "signature": [ + "FunctionDefinition" + ], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", "lineNumber": 200 }, - "signature": [ - "FunctionDefinition" - ] + "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: ", { @@ -8168,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", @@ -8184,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", @@ -8231,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": 60 - }, "signature": [ "({ data, negate, }: ", "ValueClickDataContext", @@ -8299,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": [], + "signature": [ + "typeof ", + "createFiltersFromRangeSelectAction" + ], "source": { "path": "src/plugins/data/public/types.ts", "lineNumber": 61 }, - "signature": [ - "typeof ", - "createFiltersFromRangeSelectAction" - ] + "deprecated": false } ], - "source": { - "path": "src/plugins/data/public/types.ts", - "lineNumber": 59 - }, "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": 52 - }, "signature": [ "React.ComponentType<", { @@ -8352,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": 53 - }, "signature": [ "React.ComponentType<", { @@ -8374,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": 51 - }, "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", @@ -8522,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": 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": 109 - }, "signature": [ { "pluginId": "core", @@ -8554,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": 110 - }, "signature": [ { "pluginId": "core", @@ -8574,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": 111 - }, "signature": [ { "pluginId": "core", @@ -8594,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": 112 - }, "signature": [ { "pluginId": "core", @@ -8614,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": 113 - }, "signature": [ { "pluginId": "kibanaUtils", @@ -8635,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": 114 - }, "signature": [ { "pluginId": "data", @@ -8655,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": 115 - }, "signature": [ { "pluginId": "usageCollection", @@ -8676,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": 107 - }, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-public.IEsSearchRequest", "type": "Interface", + "tags": [], "label": "IEsSearchRequest", + "description": [], "signature": [ { "pluginId": "data", @@ -8715,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/strategies/es_search/types.ts", "lineNumber": 19 }, - "signature": [ - "string | undefined" - ] + "deprecated": false } ], - "source": { - "path": "src/plugins/data/common/search/strategies/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", @@ -8983,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: ", { @@ -9078,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", @@ -9115,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": [ "(() => ", { @@ -9187,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: ", { @@ -9264,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", @@ -9295,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: ", { @@ -9313,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", @@ -9329,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": [ "() => ", { @@ -9358,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) => ", { @@ -9382,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) => ", { @@ -9421,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: ", { @@ -9460,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", @@ -9476,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: ", { @@ -9521,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", @@ -9538,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: ", { @@ -9567,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", @@ -9583,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: ", { @@ -9643,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: ", { @@ -9696,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", @@ -9733,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", @@ -9787,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", @@ -10157,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", @@ -10200,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", @@ -10279,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": 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": 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": 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": 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": 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": 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": 126 - }, "signature": [ { "pluginId": "data", @@ -10426,20 +11693,22 @@ "text": "IndexPattern" }, " | undefined" - ] + ], + "source": { + "path": "src/plugins/data/common/search/types.ts", + "lineNumber": 126 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-public.ISearchOptions.inspector", "type": "Object", + "tags": [], "label": "inspector", "description": [ "\nInspector integration options" ], - "source": { - "path": "src/plugins/data/common/search/types.ts", - "lineNumber": 131 - }, "signature": [ { "pluginId": "data", @@ -10449,38 +11718,40 @@ "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": 90 - }, "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": 31 - }, "signature": [ "(fields?: ", { @@ -10499,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": 35 - }, "signature": [ "() => Pick<", { @@ -10523,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": 26 - }, "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: ", { @@ -10637,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": 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": 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": 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": 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": 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": 36 - } + }, + "deprecated": false } ], - "source": { - "path": "src/plugins/data/common/search/search_source/fetch/types.ts", - "lineNumber": 30 - }, "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": 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": 75 - }, "signature": [ { "pluginId": "data", @@ -10918,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": 79 - }, "signature": [ { "pluginId": "data", @@ -10965,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": 83 - }, "signature": [ "Record object) | undefined" - ] + ], + "source": { + "path": "src/plugins/data/common/search/search_source/types.ts", + "lineNumber": 90 + }, + "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": 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": 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": 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": 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": 98 - }, "signature": [ { "pluginId": "data", @@ -11165,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": 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": 108 - }, "signature": [ { "pluginId": "data", @@ -11206,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": 109 - }, "signature": [ { "pluginId": "data", @@ -11227,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": 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": 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": 113 - }, "signature": [ { "pluginId": "data", @@ -11276,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": 70 - }, "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": 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": [], - "source": { - "path": "src/plugins/data/public/actions/apply_filter_action.ts", - "lineNumber": 16 - }, "signature": [ "\"ACTION_GLOBAL_APPLY_FILTER\"" ], + "source": { + "path": "src/plugins/data/public/actions/apply_filter_action.ts", + "lineNumber": 16 + }, + "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: ", { @@ -11513,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": [], + "signature": [ + "\"es\"" + ], "source": { "path": "src/plugins/data/common/search/strategies/es_search/types.ts", "lineNumber": 12 }, - "signature": [ - "\"es\"" - ], + "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, ", { @@ -11591,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\", ", { @@ -11639,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": 55 }, - "signature": [ - "{ [x: string]: SortDirection | SortDirectionNumeric | SortDirectionFormat; }" - ], + "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\", ", { @@ -11730,18 +13149,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-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\", ", { @@ -11761,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": [], + "signature": [ + "AggType>" + ], "source": { "path": "src/plugins/data/common/search/aggs/agg_type.ts", "lineNumber": 62 }, - "signature": [ - "AggType>" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-public.IEsSearchResponse", "type": "Type", - "label": "IEsSearchResponse", "tags": [], + "label": "IEsSearchResponse", "description": [], + "signature": [ + "IKibanaSearchResponse>" + ], "source": { "path": "src/plugins/data/common/search/strategies/es_search/types.ts", "lineNumber": 22 }, - "signature": [ - "IKibanaSearchResponse>" - ], + "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: ", { @@ -11939,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, ", { @@ -12002,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: ", { @@ -12042,22 +13491,22 @@ "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": 20 - }, "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?: ", { @@ -12088,254 +13537,296 @@ "text": "ISearchOptions" } ], + "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 ", { @@ -12345,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 ", { @@ -12366,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) => ", { @@ -12387,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: ", { @@ -12424,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: ", { @@ -12461,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: ", { @@ -12498,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) => ", { @@ -12519,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: ", { @@ -12564,18 +14069,20 @@ "section": "def-common.RangeFilter", "text": "RangeFilter" } - ] - }, - { - "tags": [], + ], + "source": { + "path": "src/plugins/data/public/index.ts", + "lineNumber": 68 + }, + "deprecated": false + }, + { + "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 ", { @@ -12585,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 ", { @@ -12606,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 ", { @@ -12627,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 ", { @@ -12648,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 ", { @@ -12669,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 ", { @@ -12690,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 ", { @@ -12711,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: ", { @@ -12733,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: ", { @@ -12763,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: ", { @@ -12792,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: ", { @@ -12814,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: ", { @@ -12836,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 ", { @@ -12857,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: ", { @@ -12910,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", @@ -12930,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?: ", { @@ -12975,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: ", { @@ -13035,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<", { @@ -13122,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: ", { @@ -13159,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 ", { @@ -13194,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 ", { @@ -13215,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: ", { @@ -13261,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 ", { @@ -13282,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 ", { @@ -13303,32 +14872,36 @@ "section": "def-common.decorateQuery", "text": "decorateQuery" } - ] + ], + "source": { + "path": "src/plugins/data/public/index.ts", + "lineNumber": 134 + }, + "deprecated": false } ], - "description": [], - "label": "esQuery", - "source": { - "path": "src/plugins/data/public/index.ts", - "lineNumber": 129 - }, "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 ", { @@ -13338,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 ", { @@ -13384,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 ", { @@ -13405,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", @@ -13439,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", @@ -13459,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 ", { @@ -13480,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 ", { @@ -13501,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 ", { @@ -13522,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 ", { @@ -13543,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 ", { @@ -13594,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 ", { @@ -13615,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 ", { @@ -13636,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 ", { @@ -13657,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 ", { @@ -13678,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 ", { @@ -13699,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 ", { @@ -13720,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 ", { @@ -13741,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 ", { @@ -13762,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 ", { @@ -13783,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 ", { @@ -13804,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: ", { @@ -13890,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 ", { @@ -13911,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 ", { @@ -13932,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": [], - "source": { - "path": "src/plugins/data/public/index.ts", - "lineNumber": 248 - }, "signature": [ "typeof ", "formatHitProvider" - ] + ], + "source": { + "path": "src/plugins/data/public/index.ts", + "lineNumber": 248 + }, + "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": 409 - }, "signature": [ "typeof ", { @@ -14017,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": 410 - }, "signature": [ "typeof ", { @@ -14038,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": 411 - }, "signature": [ "({ display: string; val: string; enabled(agg: ", { @@ -14060,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": 412 - }, "signature": [ "typeof ", { @@ -14081,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": 413 - }, "signature": [ "typeof ", { @@ -14102,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": 414 - }, "signature": [ "typeof ", { @@ -14123,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": 415 - }, "signature": [ "typeof ", { @@ -14144,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": 416 - }, "signature": [ "(agg: ", { @@ -14166,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": 417 - }, "signature": [ "(agg: ", { @@ -14188,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": 418 - }, "signature": [ "(...types: string[]) => (agg: ", { @@ -14210,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": 419 - }, "signature": [ "typeof ", { @@ -14231,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": 420 - }, "signature": [ "typeof ", { @@ -14252,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": 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": 422 - }, "signature": [ "typeof ", { @@ -14284,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": 423 - }, "signature": [ "typeof ", { @@ -14305,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": 424 - }, "signature": [ "typeof ", { @@ -14326,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": 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": 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": 427 - }, "signature": [ "typeof ", { @@ -14372,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": 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": 429 - }, "signature": [ "(column: ", { @@ -14408,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": 430 - }, "signature": [ "(column: ", { @@ -14438,26 +16135,22 @@ "text": "TimeRange" }, " | undefined; } | undefined" - ] + ], + "source": { + "path": "src/plugins/data/public/index.ts", + "lineNumber": 430 + }, + "deprecated": false } - ], - "description": [], - "label": "aggs", - "source": { - "path": "src/plugins/data/public/index.ts", - "lineNumber": 408 - } + ] }, { - "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 ", { @@ -14467,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 ", { @@ -14488,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 ", { @@ -14509,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": 407 - }, "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": 42 - }, "signature": [ "{ getQuerySuggestions: ", { @@ -14565,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": 43 - }, "signature": [ { "pluginId": "data", @@ -14585,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": 44 - }, "signature": [ "Pick<", { @@ -14607,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": 45 - }, "signature": [ "{ filterManager: ", { @@ -14642,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": 41 - }, "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": 72 - }, "signature": [ { "pluginId": "data", @@ -14681,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": 77 - }, "signature": [ "{ getQuerySuggestions: ", { @@ -14707,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": 82 - }, "signature": [ "Pick<", { @@ -14731,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": 87 - }, "signature": [ { "pluginId": "data", @@ -14753,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": 92 - }, "signature": [ { "pluginId": "data", @@ -14775,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": 97 - }, "signature": [ "{ addToQueryLog: (appName: string, { language, query }: ", { @@ -14818,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": 102 - }, "signature": [ { "pluginId": "data", @@ -14840,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": 104 - }, "signature": [ "Pick, \"get\">" - ] + ], + "source": { + "path": "src/plugins/data/public/types.ts", + "lineNumber": 104 + }, + "deprecated": false } ], - "source": { - "path": "src/plugins/data/public/types.ts", - "lineNumber": 67 - }, "lifecycle": "start", "initialIsOpen": true } @@ -14870,6 +16596,7 @@ "server": { "classes": [ { + "parentPluginId": "data", "id": "def-server.AggParamType", "type": "Class", "tags": [], @@ -14893,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": [], @@ -15003,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", @@ -15028,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: ", { @@ -15070,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", @@ -15097,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: ", { @@ -15171,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", @@ -15187,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": [], @@ -15247,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", @@ -15308,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", @@ -15337,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", @@ -15476,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" @@ -15489,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]: ", { @@ -15573,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": [ "() => ", { @@ -15620,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": [ "() => ", { @@ -15762,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": [ "() => ", { @@ -15786,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": [ "() => ", { @@ -15842,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) => ", { @@ -15866,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: ", { @@ -15962,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", @@ -15996,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: ", { @@ -16025,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", @@ -16059,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" ], - "children": [ - { - "id": "def-server.IndexPattern.removeRuntimeField.$1", + "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) => ", { @@ -16125,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: ", { @@ -16166,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", @@ -16211,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", + "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", @@ -16348,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 } ], - "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 - }, - "tags": [], "returnComment": [] }, { + "parentPluginId": "data", "id": "def-server.IndexPatternsService.getTitles", "type": "Function", - "children": [ + "tags": [], + "label": "getTitles", + "description": [ + "\nGet list of index pattern titles" + ], + "signature": [ + "(refresh?: boolean) => Promise" + ], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", + "lineNumber": 122 + }, + "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", @@ -16665,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<", { @@ -16689,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", @@ -16765,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", @@ -16781,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", @@ -16822,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", @@ -16843,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: ", { @@ -16859,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", @@ -16908,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", @@ -16956,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", @@ -16977,62 +18998,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", "<", @@ -17045,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" + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", + "lineNumber": 343 + }, + "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<", @@ -17115,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: ", { @@ -17149,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", @@ -17167,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: ", { @@ -17220,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", @@ -17238,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: ", { @@ -17307,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", @@ -17325,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: ", { @@ -17370,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", @@ -17388,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" ], + "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", @@ -17724,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<", { @@ -17748,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", @@ -17824,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", @@ -17840,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", @@ -17881,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", @@ -17902,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: ", { @@ -17918,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", @@ -17967,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", @@ -18015,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", @@ -18036,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", "<", @@ -18104,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<", @@ -18174,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: ", { @@ -18208,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", @@ -18226,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: ", { @@ -18279,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", @@ -18297,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: ", { @@ -18366,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", @@ -18384,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: ", { @@ -18429,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", @@ -18447,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": [], @@ -18563,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", @@ -18583,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": [], + "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) => ", @@ -18654,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: ", { @@ -18699,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", @@ -18716,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", @@ -18736,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: ", { @@ -19362,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", @@ -19378,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", @@ -19546,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/strategies/es_search/types.ts", "lineNumber": 19 }, - "signature": [ - "string | undefined" - ] + "deprecated": false } ], - "source": { - "path": "src/plugins/data/common/search/strategies/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", @@ -19814,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: ", { @@ -19909,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": 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": 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": 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": 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": 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": 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": 126 - }, "signature": [ { "pluginId": "data", @@ -20202,20 +22584,22 @@ "text": "IndexPattern" }, " | undefined" - ] + ], + "source": { + "path": "src/plugins/data/common/search/types.ts", + "lineNumber": 126 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-server.ISearchOptions.inspector", "type": "Object", + "tags": [], "label": "inspector", "description": [ "\nInspector integration options" ], - "source": { - "path": "src/plugins/data/common/search/types.ts", - "lineNumber": 131 - }, "signature": [ { "pluginId": "data", @@ -20225,110 +22609,126 @@ "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": 90 - }, "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: ", { @@ -20339,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": [], + "signature": [ + "\"es\"" + ], "source": { "path": "src/plugins/data/common/search/strategies/es_search/types.ts", "lineNumber": 12 }, - "signature": [ - "\"es\"" - ], + "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, ", { @@ -20531,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\", ", { @@ -20577,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\", ", { @@ -20608,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": [], + "signature": [ + "AggType>" + ], "source": { "path": "src/plugins/data/common/search/aggs/agg_type.ts", "lineNumber": 62 }, - "signature": [ - "AggType>" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-server.IEsSearchResponse", "type": "Type", - "label": "IEsSearchResponse", "tags": [], + "label": "IEsSearchResponse", "description": [], + "signature": [ + "IKibanaSearchResponse>" + ], "source": { "path": "src/plugins/data/common/search/strategies/es_search/types.ts", "lineNumber": 22 }, - "signature": [ - "IKibanaSearchResponse>" - ], + "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: ", { @@ -20737,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, ", { @@ -20800,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) => ", { @@ -20950,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 ", { @@ -20971,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) => ", { @@ -20992,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: ", { @@ -21029,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 ", { @@ -21050,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: ", { @@ -21087,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: ", { @@ -21124,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: ", { @@ -21169,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: ", { @@ -21191,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<", { @@ -21248,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: ", { @@ -21285,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: ", { @@ -21345,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 ", { @@ -21366,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 ", { @@ -21387,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 ", { @@ -21422,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 ", { @@ -21468,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 ", { @@ -21489,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 ", { @@ -21510,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 ", { @@ -21531,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 ", { @@ -21552,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 ", { @@ -21573,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 ", { @@ -21594,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 ", { @@ -21615,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 ", { @@ -21636,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 ", { @@ -21657,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 ", { @@ -21678,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 ", { @@ -21699,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 ", { @@ -21720,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 ", { @@ -21741,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 ", { @@ -21762,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 ", { @@ -21783,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 ", { @@ -21818,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 ", { @@ -21839,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": 245 - }, "signature": [ "typeof ", { @@ -21879,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": 246 - }, "signature": [ "typeof ", { @@ -21900,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": 247 - }, "signature": [ "({ display: string; val: string; enabled(agg: ", { @@ -21922,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": 248 - }, "signature": [ "typeof ", { @@ -21943,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": 249 - }, "signature": [ "typeof ", { @@ -21964,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": 250 - }, "signature": [ "typeof ", { @@ -21985,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": 251 - }, "signature": [ "(agg: ", { @@ -22007,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": 252 - }, "signature": [ "(agg: ", { @@ -22029,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": 253 - }, "signature": [ "(...types: string[]) => (agg: ", { @@ -22051,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": 254 - }, "signature": [ "typeof ", { @@ -22072,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": 255 - }, "signature": [ "typeof ", { @@ -22093,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": 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": 257 - }, "signature": [ "typeof ", { @@ -22125,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": 258 - }, "signature": [ "typeof ", { @@ -22146,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": 259 - }, "signature": [ "typeof ", { @@ -22167,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": 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": 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": 262 - }, "signature": [ "typeof ", { @@ -22213,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": 263 - }, "signature": [ "typeof ", { @@ -22234,26 +24830,22 @@ "section": "def-common.calcAutoIntervalLessThan", "text": "calcAutoIntervalLessThan" } - ] + ], + "source": { + "path": "src/plugins/data/server/index.ts", + "lineNumber": 263 + }, + "deprecated": false } - ], - "description": [], - "label": "aggs", - "source": { - "path": "src/plugins/data/server/index.ts", - "lineNumber": 244 - } + ] }, { - "tags": [], + "parentPluginId": "data", "id": "def-server.search.tabifyAggResponse", "type": "Function", + "tags": [], "label": "tabifyAggResponse", "description": [], - "source": { - "path": "src/plugins/data/server/index.ts", - "lineNumber": 265 - }, "signature": [ "typeof ", { @@ -22263,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": 266 - }, "signature": [ "typeof ", { @@ -22284,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": 243 - }, "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", @@ -22336,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", @@ -22404,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: ", { @@ -22434,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 } @@ -22462,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 ", { @@ -22521,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<", { @@ -22548,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": [], @@ -22585,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: ", { @@ -22673,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", @@ -22759,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: ", { @@ -22873,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", @@ -22890,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", @@ -22919,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", @@ -22950,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", @@ -22972,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", @@ -23007,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", @@ -23027,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: ", { @@ -23116,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", @@ -23132,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", @@ -23152,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", @@ -23172,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", @@ -23249,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", @@ -23282,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", @@ -23316,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: ", { @@ -23332,7 +26098,7 @@ "section": "def-common.IFieldType", "text": "IFieldType" }, - ", value: any, indexPattern: ", + ", params: any[], indexPattern: ", { "pluginId": "data", "scope": "common", @@ -23345,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", @@ -23377,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", @@ -23411,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" - } + "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" + }, + "[]; }" ], - "description": [], - "label": "buildQueryFilter", "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", @@ -23540,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", @@ -23561,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", @@ -23645,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", @@ -23665,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", @@ -23685,89 +26492,44 @@ "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 - } - } - ], - "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) => ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataPluginApi", - "section": "def-common.RangeFilter", - "text": "RangeFilter" + }, + "deprecated": false, + "isRequired": false } ], - "description": [], - "label": "buildRangeFilter", - "source": { - "path": "src/plugins/data/common/es_query/filters/range_filter.ts", - "lineNumber": 93 - }, - "tags": [], "returnComment": [], "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.castEsToKbnFieldTypeName", "type": "Function", - "children": [ - { - "id": "def-common.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) => ", @@ -23779,44 +26541,41 @@ "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-common.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-common.cleanFilter", "type": "Function", - "children": [ - { - "id": "def-common.cleanFilter.$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/index.ts", - "lineNumber": 36 - } - } + "tags": [], + "label": "cleanFilter", + "description": [ + "\nClean out any invalid attributes from the filters" ], "signature": [ "(filter: ", @@ -23836,22 +26595,46 @@ "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": [], + "deprecated": false, + "children": [ + { + "parentPluginId": "data", + "id": "def-common.cleanFilter.$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/index.ts", + "lineNumber": 36 + }, + "deprecated": false, + "isRequired": true + } + ], "returnComment": [], "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.datatableToCSV", "type": "Function", + "tags": [], "label": "datatableToCSV", + "description": [], "signature": [ "({ columns, rows }: ", { @@ -23863,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", @@ -23879,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: ", { @@ -23930,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", @@ -23948,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", @@ -24015,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: ", { @@ -24040,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", @@ -24068,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<", { @@ -24137,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<", { @@ -24162,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<", { @@ -24206,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: ", { @@ -24264,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", @@ -24280,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", @@ -24301,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) => ", { @@ -24330,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", @@ -24373,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", @@ -24440,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: ", { @@ -24483,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", @@ -24499,30 +27358,48 @@ "text": "Filter" } ], - "description": [], "source": { "path": "src/plugins/data/common/es_query/filters/get_filter_params.ts", "lineNumber": 11 - } - } - ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/data/common/es_query/filters/get_filter_params.ts", - "lineNumber": 11 - }, + }, + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [], "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", @@ -24532,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", @@ -24578,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: ", { @@ -24637,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", @@ -24653,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", @@ -24674,39 +27551,27 @@ }, "[]" ], - "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" + ], + "label": "getKbnFieldType", + "description": [ + "\n Get a type object by name\n" ], "signature": [ "(typeName: string) => ", @@ -24718,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", @@ -24771,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", @@ -24817,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: ", { @@ -24833,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", @@ -24863,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", @@ -24909,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", @@ -24969,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", @@ -25015,43 +27945,64 @@ "text": "RangeFilter" } ], - "description": [], "source": { "path": "src/plugins/data/common/es_query/filters/range_filter.ts", "lineNumber": 81 - } + }, + "deprecated": false, + "isRequired": true } ], + "returnComment": [], + "initialIsOpen": false + }, + { + "parentPluginId": "data", + "id": "def-common.getRangeScript", + "type": "Function", + "tags": [], + "label": "getRangeScript", + "description": [], "signature": [ - "(filter: ", + "(field: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IFieldType", + "text": "IFieldType" + }, + ", params: ", { "pluginId": "data", "scope": "common", "docId": "kibDataPluginApi", - "section": "def-common.RangeFilter", - "text": "RangeFilter" + "section": "def-common.RangeFilterParams", + "text": "RangeFilterParams" }, - ") => string" + ") => { script: { source: string; params: Partial<", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.RangeFilterParams", + "text": "RangeFilterParams" + }, + ">; lang: string | undefined; }; }" ], - "description": [], - "label": "getRangeFilterField", "source": { "path": "src/plugins/data/common/es_query/filters/range_filter.ts", - "lineNumber": 81 + "lineNumber": 140 }, - "tags": [], - "returnComment": [], - "initialIsOpen": false - }, - { - "id": "def-common.getRangeScript", - "type": "Function", + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-common.getRangeScript.$1", "type": "Object", + "tags": [], "label": "field", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "data", @@ -25061,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", @@ -25081,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", @@ -25221,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: ", { @@ -25237,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", @@ -25267,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", @@ -25283,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 ", { @@ -25364,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 ", { @@ -25403,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 ", { @@ -25442,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 ", { @@ -25481,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 ", { @@ -25520,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 ", { @@ -25559,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 ", { @@ -25598,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 ", { @@ -25637,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 ", { @@ -25676,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 ", { @@ -25715,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) => ", { @@ -25739,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: ", { @@ -25807,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", @@ -25871,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", @@ -25892,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: ", { @@ -26009,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", @@ -26037,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: ", { @@ -26063,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", @@ -26091,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: ", { @@ -26125,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", @@ -26153,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: ", { @@ -26178,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]: ", { @@ -26281,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", @@ -26421,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", @@ -26607,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`" @@ -26776,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." @@ -26789,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" }, " | ", { @@ -27140,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 | ", { @@ -27484,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", @@ -27500,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", @@ -27531,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: ", { @@ -27556,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", @@ -27584,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 255607a888033..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": [], + "signature": [ + "\"ese\"" + ], "source": { "path": "src/plugins/data/common/search/strategies/ese_search/types.ts", "lineNumber": 11 }, - "signature": [ - "\"ese\"" - ], + "deprecated": false, "initialIsOpen": false }, { - "tags": [], + "parentPluginId": "dataEnhanced", "id": "def-public.EQL_SEARCH_STRATEGY", "type": "string", + "tags": [], "label": "EQL_SEARCH_STRATEGY", "description": [], + "signature": [ + "\"eql\"" + ], "source": { "path": "src/plugins/data/common/search/strategies/eql_search/types.ts", "lineNumber": 14 }, - "signature": [ - "\"eql\"" - ], + "deprecated": false, "initialIsOpen": false } ], "objects": [], "start": { + "parentPluginId": "dataEnhanced", "id": "def-public.DataEnhancedStart", "type": "Type", - "label": "DataEnhancedStart", "tags": [], + "label": "DataEnhancedStart", "description": [], + "signature": [ + "void" + ], "source": { "path": "x-pack/plugins/data_enhanced/public/plugin.ts", "lineNumber": 37 }, - "signature": [ - "void" - ], + "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", @@ -110,24 +131,23 @@ }, "; 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": 26 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "x-pack/plugins/data_enhanced/server/plugin.ts", - "lineNumber": 26 - } + "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": 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": 31 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "x-pack/plugins/data_enhanced/server/plugin.ts", - "lineNumber": 31 - } + "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": 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": 54 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "x-pack/plugins/data_enhanced/server/plugin.ts", - "lineNumber": 54 - } + "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": 60 - } + }, + "deprecated": false, + "children": [], + "returnComment": [] } ], - "source": { - "path": "x-pack/plugins/data_enhanced/server/plugin.ts", - "lineNumber": 20 - }, "initialIsOpen": false } ], @@ -280,33 +311,37 @@ "enums": [], "misc": [ { - "tags": [], + "parentPluginId": "dataEnhanced", "id": "def-server.ENHANCED_ES_SEARCH_STRATEGY", "type": "string", + "tags": [], "label": "ENHANCED_ES_SEARCH_STRATEGY", "description": [], + "signature": [ + "\"ese\"" + ], "source": { "path": "src/plugins/data/common/search/strategies/ese_search/types.ts", "lineNumber": 11 }, - "signature": [ - "\"ese\"" - ], + "deprecated": false, "initialIsOpen": false }, { - "tags": [], + "parentPluginId": "dataEnhanced", "id": "def-server.EQL_SEARCH_STRATEGY", "type": "string", + "tags": [], "label": "EQL_SEARCH_STRATEGY", "description": [], + "signature": [ + "\"eql\"" + ], "source": { "path": "src/plugins/data/common/search/strategies/eql_search/types.ts", "lineNumber": 14 }, - "signature": [ - "\"eql\"" - ], + "deprecated": false, "initialIsOpen": false } ], 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 c525710048c15..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": 22 - } - } - ], - "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" + }, + "deprecated": false, + "isRequired": true } ], - "description": [], - "label": "createSavedQueryService", - "source": { - "path": "src/plugins/data/public/query/saved_query/saved_query_service.ts", - "lineNumber": 21 - }, - "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 565f6b087590f..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,22 +58,36 @@ "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": [ { "pluginId": "data", @@ -78,17 +97,20 @@ "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", @@ -99,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: ", { @@ -128,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", @@ -144,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", @@ -195,40 +229,45 @@ "text": "SearchInterceptorDeps" } ], - "description": [], "source": { "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/search_interceptor.ts", - "lineNumber": 93 - } + "returnComment": [] }, { + "parentPluginId": "data", "id": "def-public.SearchInterceptor.stop", "type": "Function", + "tags": [], "label": "stop", + "description": [], "signature": [ "() => void" ], - "description": [], - "children": [], - "tags": [], - "returnComment": [], "source": { "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": [ "({ id, ...request }: ", { @@ -258,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", + "tags": [], "label": "{ id, ...request }", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "data", @@ -277,17 +320,20 @@ }, "" ], - "description": [], "source": { "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", @@ -297,63 +343,59 @@ "text": "IAsyncSearchOptions" } ], - "description": [], "source": { "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/search_interceptor.ts", - "lineNumber": 313 - } + ] }, { + "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/search_interceptor.ts", "lineNumber": 386 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/data/public/search/search_interceptor/search_interceptor.ts", - "lineNumber": 386 - } + "returnComment": [] } ], - "source": { - "path": "src/plugins/data/public/search/search_interceptor/search_interceptor.ts", - "lineNumber": 67 - }, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-public.SearchTimeoutError", "type": "Class", "tags": [], @@ -378,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": 25 - }, "signature": [ { "pluginId": "data", @@ -397,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": 26 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "data", "id": "def-public.SearchTimeoutError.Unnamed.$2", "type": "Enum", + "tags": [], "label": "mode", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "data", @@ -436,24 +497,23 @@ "text": "TimeoutErrorMode" } ], - "description": [], "source": { "path": "src/plugins/data/public/search/errors/timeout_error.tsx", "lineNumber": 26 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/data/public/search/errors/timeout_error.tsx", - "lineNumber": 26 - } + "returnComment": [] }, { + "parentPluginId": "data", "id": "def-public.SearchTimeoutError.getErrorMessage", "type": "Function", + "tags": [], "label": "getErrorMessage", + "description": [], "signature": [ "(application: ", { @@ -465,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", @@ -481,33 +547,28 @@ "text": "ApplicationStart" } ], - "description": [], "source": { "path": "src/plugins/data/public/search/errors/timeout_error.tsx", "lineNumber": 66 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/data/public/search/errors/timeout_error.tsx", - "lineNumber": 66 - } + "returnComment": [] } ], - "source": { - "path": "src/plugins/data/public/search/errors/timeout_error.tsx", - "lineNumber": 24 - }, "initialIsOpen": false } ], "functions": [ { + "parentPluginId": "data", "id": "def-public.getEsPreference", "type": "Function", + "tags": [], "label": "getEsPreference", + "description": [], "signature": [ "(uiSettings: ", { @@ -519,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", @@ -535,73 +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": [], - "source": { - "path": "src/plugins/data/public/search/es_search/get_es_preference.ts", - "lineNumber": 14 - }, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-public.isEsError", "type": "Function", + "tags": [], "label": "isEsError", - "signature": [ - "(e: any) => boolean" - ], "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/errors/types.ts", + "lineNumber": 51 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-public.isEsError.$1", "type": "Any", + "tags": [], "label": "e", - "isRequired": true, + "description": [], "signature": [ "any" ], - "description": [], "source": { "path": "src/plugins/data/public/search/errors/types.ts", "lineNumber": 51 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], "returnComment": [], - "source": { - "path": "src/plugins/data/public/search/errors/types.ts", - "lineNumber": 51 - }, "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", @@ -625,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" - ], - "children": [ - { + "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", @@ -661,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": 24 }, - "signature": [ - "AggsCommonSetup" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-public.ISearchSetup.usageCollector", "type": "Object", + "tags": [], "label": "usageCollector", "description": [], + "signature": [ + "SearchUsageCollector", + " | undefined" + ], "source": { "path": "src/plugins/data/public/search/types.ts", "lineNumber": 25 }, - "signature": [ - "SearchUsageCollector", - " | undefined" - ] + "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": 30 - }, "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": 35 - }, "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": 23 - }, "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": 48 - }, "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": 53 - }, "signature": [ { "pluginId": "data", @@ -812,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": 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": 60 - }, "signature": [ { "pluginId": "data", @@ -848,174 +944,198 @@ "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": 65 - }, "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": 70 - }, "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": 42 - }, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-public.Reason", "type": "Interface", + "tags": [], "label": "Reason", "description": [], - "tags": [], + "source": { + "path": "src/plugins/data/public/search/errors/types.ts", + "lineNumber": 18 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "data", "id": "def-public.Reason.type", "type": "string", + "tags": [], "label": "type", "description": [], "source": { "path": "src/plugins/data/public/search/errors/types.ts", "lineNumber": 19 - } + }, + "deprecated": false }, { - "tags": [], + "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 }, { - "tags": [], + "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 }, - "signature": [ - "string[] | undefined" - ] + "deprecated": false }, { - "tags": [], + "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 }, - "signature": [ - "{ offset: number; start: number; end: number; } | undefined" - ] + "deprecated": false }, { - "tags": [], + "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 }, - "signature": [ - "string | undefined" - ] + "deprecated": false }, { - "tags": [], + "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 }, - "signature": [ - "string | undefined" - ] + "deprecated": false }, { - "tags": [], + "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 }, - "signature": [ - "{ type: string; reason: string; } | undefined" - ] + "deprecated": false } ], - "source": { - "path": "src/plugins/data/public/search/errors/types.ts", - "lineNumber": 18 - }, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-public.SearchInterceptorDeps", "type": "Interface", + "tags": [], "label": "SearchInterceptorDeps", "description": [], - "tags": [], + "source": { + "path": "src/plugins/data/public/search/search_interceptor/search_interceptor.ts", + "lineNumber": 54 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "data", "id": "def-public.SearchInterceptorDeps.bfetch", "type": "Object", + "tags": [], "label": "bfetch", "description": [], - "source": { - "path": "src/plugins/data/public/search/search_interceptor/search_interceptor.ts", - "lineNumber": 55 - }, "signature": [ { "pluginId": "bfetch", @@ -1024,18 +1144,20 @@ "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/search_interceptor.ts", - "lineNumber": 56 - }, "signature": [ { "pluginId": "core", @@ -1044,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/search_interceptor.ts", - "lineNumber": 57 - }, "signature": [ { "pluginId": "core", @@ -1064,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/search_interceptor.ts", - "lineNumber": 58 - }, "signature": [ "Promise<[", { @@ -1086,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/search_interceptor.ts", - "lineNumber": 59 - }, "signature": [ "Pick<", { @@ -1108,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": [], + "signature": [ + "SearchUsageCollector", + " | undefined" + ], "source": { "path": "src/plugins/data/public/search/search_interceptor/search_interceptor.ts", "lineNumber": 60 }, - "signature": [ - "SearchUsageCollector", - " | undefined" - ] + "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/search_interceptor.ts", - "lineNumber": 61 - }, "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/search_interceptor.ts", - "lineNumber": 54 - }, "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", @@ -1162,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: ", { @@ -1227,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" ], @@ -1284,71 +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", - "label": "IEsError", "tags": [], + "label": "IEsError", "description": [], + "signature": [ + "KibanaServerError" + ], "source": { "path": "src/plugins/data/public/search/errors/types.ts", "lineNumber": 43 }, - "signature": [ - "KibanaServerError" - ], + "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" @@ -1357,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 } ], @@ -1381,9 +1538,12 @@ "classes": [], "functions": [ { + "parentPluginId": "data", "id": "def-server.getDefaultSearchParams", "type": "Function", + "tags": [], "label": "getDefaultSearchParams", + "description": [], "signature": [ "(uiSettingsClient: ", { @@ -1399,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", @@ -1415,25 +1581,24 @@ "text": "IUiSettingsClient" } ], - "description": [], "source": { "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/strategies/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", @@ -1446,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", @@ -1462,25 +1633,26 @@ "ByteSizeValue", ") => boolean; getValueInBytes: () => number; toString: (returnUnit?: \"b\" | \"kb\" | \"mb\" | \"gb\" | undefined) => string; }>; }>; }>" ], - "description": [], "source": { "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/strategies/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", @@ -1510,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", @@ -1543,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", @@ -1563,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: ", { @@ -1600,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", @@ -1617,27 +1804,26 @@ }, "" ], - "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", @@ -1648,93 +1834,107 @@ }, "" ], - "description": [], - "tags": [], + "source": { + "path": "src/plugins/data/server/search/strategies/ese_search/types.ts", + "lineNumber": 12 + }, + "deprecated": false, "children": [ { - "tags": [], + "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 }, - "signature": [ - "string | undefined" - ] + "deprecated": false }, { - "tags": [], + "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 }, - "signature": [ - "SearchResponse", - "" - ] + "deprecated": false }, { - "tags": [], + "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 }, { - "tags": [], + "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 }, { - "tags": [], + "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 }, { - "tags": [], + "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 } ], - "source": { - "path": "src/plugins/data/server/search/strategies/ese_search/types.ts", - "lineNumber": 12 - }, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-server.AsyncSearchStatusResponse", "type": "Interface", + "tags": [], "label": "AsyncSearchStatusResponse", + "description": [], "signature": [ { "pluginId": "data", @@ -1753,45 +1953,51 @@ }, ", \"id\" | \"start_time_in_millis\" | \"expiration_time_in_millis\" | \"is_partial\" | \"is_running\">" ], - "description": [], - "tags": [], + "source": { + "path": "src/plugins/data/server/search/strategies/ese_search/types.ts", + "lineNumber": 20 + }, + "deprecated": false, "children": [ { - "tags": [], + "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 }, { - "tags": [], + "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 }, - "signature": [ - "ShardsResponse" - ] + "deprecated": false } ], - "source": { - "path": "src/plugins/data/server/search/strategies/ese_search/types.ts", - "lineNumber": 20 - }, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-server.IScopedSearchClient", "type": "Interface", + "tags": [], "label": "IScopedSearchClient", + "description": [], "signature": [ { "pluginId": "data", @@ -1809,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<", { @@ -1872,18 +2082,20 @@ "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<", { @@ -1894,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<", { @@ -1944,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", @@ -1967,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": 39 - }, "signature": [ "(core: ", { @@ -2000,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": 38 - }, "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) => ", { @@ -2168,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: ", { @@ -2197,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: ", { @@ -2227,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", @@ -2250,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: ", { @@ -2285,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: ", { @@ -2315,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: ", { @@ -2345,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<", { @@ -2381,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", @@ -2401,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", @@ -2421,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 } ], @@ -2530,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 ", { @@ -2551,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 ", { @@ -2598,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", @@ -2617,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", @@ -2653,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", @@ -2710,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": [], - "children": [ - { + "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", @@ -2763,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?: ", { @@ -2892,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", @@ -2909,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": [], + "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<", { @@ -3007,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<", { @@ -3027,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", @@ -3048,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?: ", { @@ -3079,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", @@ -3098,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": [ "() => ", { @@ -3193,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": [ "() => ", { @@ -3227,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": [ "() => ", { @@ -3251,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": [ "() => ", { @@ -3275,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": [], - "children": [ + "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": [ "() => ", { @@ -3455,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": [ "() => ", { @@ -3479,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", @@ -3538,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", @@ -3558,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: ", { @@ -3575,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", @@ -3591,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": 66 - }, "signature": [ { "pluginId": "data", @@ -3637,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": 67 - }, "signature": [ { "pluginId": "data", @@ -3658,46 +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": 68 }, - "signature": [ - "string[] | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.AggConfigs.hierarchical", "type": "CompoundType", + "tags": [], "label": "hierarchical", "description": [], + "signature": [ + "boolean | undefined" + ], "source": { "path": "src/plugins/data/common/search/aggs/agg_configs.ts", "lineNumber": 69 }, - "signature": [ - "boolean | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.AggConfigs.aggs", "type": "Array", + "tags": [], "label": "aggs", "description": [], - "source": { - "path": "src/plugins/data/common/search/aggs/agg_configs.ts", - "lineNumber": 73 - }, "signature": [ { "pluginId": "data", @@ -3707,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", @@ -3732,17 +4161,20 @@ "text": "IndexPattern" } ], - "description": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_configs.ts", "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": 77 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "data", "id": "def-common.AggConfigs.Unnamed.$3", "type": "Object", + "tags": [], "label": "opts", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "data", @@ -3784,55 +4219,59 @@ "text": "AggConfigsOptions" } ], - "description": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_configs.ts", "lineNumber": 78 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/data/common/search/aggs/agg_configs.ts", - "lineNumber": 75 - } + "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": 91 - } + }, + "deprecated": false, + "isRequired": false } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/data/common/search/aggs/agg_configs.ts", - "lineNumber": 91 - } + "returnComment": [] }, { + "parentPluginId": "data", "id": "def-common.AggConfigs.setTimeRange", "type": "Function", + "tags": [], "label": "setTimeRange", + "description": [], "signature": [ "(timeRange: ", { @@ -3844,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", @@ -3860,24 +4305,23 @@ "text": "TimeRange" } ], - "description": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_configs.ts", "lineNumber": 95 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/data/common/search/aggs/agg_configs.ts", - "lineNumber": 95 - } + "returnComment": [] }, { + "parentPluginId": "data", "id": "def-common.AggConfigs.clone", "type": "Function", + "tags": [], "label": "clone", + "description": [], "signature": [ "({ enabledOnly }?: { enabledOnly?: boolean | undefined; }) => ", { @@ -3888,39 +4332,88 @@ "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": 113 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/data/common/search/aggs/agg_configs.ts", - "lineNumber": 113 - } + "returnComment": [] }, { + "parentPluginId": "data", "id": "def-common.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-common.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": 127 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "data", "id": "def-common.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": 128 - } - } - ], - "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" + }, + "deprecated": false, + "isRequired": true } ], - "description": [], - "label": "createAggConfig", - "source": { - "path": "src/plugins/data/common/search/aggs/agg_configs.ts", - "lineNumber": 126 - }, - "tags": [], "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: ", { @@ -4023,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", @@ -4042,42 +4507,41 @@ }, "[]" ], - "description": [ - "an AggConfigs instance" - ], "source": { "path": "src/plugins/data/common/search/aggs/agg_configs.ts", "lineNumber": 169 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/data/common/search/aggs/agg_configs.ts", - "lineNumber": 169 - } + "returnComment": [] }, { + "parentPluginId": "data", "id": "def-common.AggConfigs.toDsl", "type": "Function", + "tags": [], "label": "toDsl", + "description": [], "signature": [ "() => Record" ], - "description": [], - "children": [], - "tags": [], - "returnComment": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_configs.ts", "lineNumber": 181 - } + }, + "deprecated": false, + "children": [], + "returnComment": [] }, { + "parentPluginId": "data", "id": "def-common.AggConfigs.getAll", "type": "Function", + "tags": [], "label": "getAll", + "description": [], "signature": [ "() => ", { @@ -4089,19 +4553,21 @@ }, "[]" ], - "description": [], - "children": [], - "tags": [], - "returnComment": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_configs.ts", "lineNumber": 250 - } + }, + "deprecated": false, + "children": [], + "returnComment": [] }, { + "parentPluginId": "data", "id": "def-common.AggConfigs.byIndex", "type": "Function", + "tags": [], "label": "byIndex", + "description": [], "signature": [ "(index: number) => ", { @@ -4112,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": 254 - } + }, + "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.byId", "type": "Function", + "tags": [], "label": "byId", + "description": [], "signature": [ "(id: string) => ", { @@ -4151,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": 258 - } + }, + "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.byName", "type": "Function", + "tags": [], "label": "byName", + "description": [], "signature": [ "(name: string) => ", { @@ -4190,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": 262 - } + }, + "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.byType", "type": "Function", + "tags": [], "label": "byType", + "description": [], "signature": [ "(type: string) => ", { @@ -4229,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": 266 - } + }, + "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.byTypeName", "type": "Function", + "tags": [], "label": "byTypeName", + "description": [], "signature": [ "(type: string) => ", { @@ -4268,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": 270 - } + }, + "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.bySchemaName", "type": "Function", + "tags": [], "label": "bySchemaName", + "description": [], "signature": [ "(schema: string) => ", { @@ -4307,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": 274 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/data/common/search/aggs/agg_configs.ts", - "lineNumber": 274 - } + "returnComment": [] }, { + "parentPluginId": "data", "id": "def-common.AggConfigs.getRequestAggs", "type": "Function", + "tags": [], "label": "getRequestAggs", + "description": [], "signature": [ "() => ", { @@ -4346,19 +4842,21 @@ }, "[]" ], - "description": [], - "children": [], - "tags": [], - "returnComment": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_configs.ts", "lineNumber": 278 - } + }, + "deprecated": false, + "children": [], + "returnComment": [] }, { + "parentPluginId": "data", "id": "def-common.AggConfigs.getRequestAggById", "type": "Function", + "tags": [], "label": "getRequestAggById", + "description": [], "signature": [ "(id: string) => ", { @@ -4370,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": 292 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/data/common/search/aggs/agg_configs.ts", - "lineNumber": 292 - } + "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": [ "() => ", { @@ -4409,23 +4916,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": 307 - } + }, + "deprecated": false, + "children": [], + "returnComment": [] }, { + "parentPluginId": "data", "id": "def-common.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) => ", { @@ -4437,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": 321 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [ - "return" - ], - "returnComment": [], - "source": { - "path": "src/plugins/data/common/search/aggs/agg_configs.ts", - "lineNumber": 321 - } + "returnComment": [] }, { + "parentPluginId": "data", "id": "def-common.AggConfigs.onSearchRequestStart", "type": "Function", + "tags": [], "label": "onSearchRequestStart", + "description": [], "signature": [ "(searchSource: Pick<", { @@ -4490,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<", { @@ -4508,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": 330 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "data", "id": "def-common.AggConfigs.onSearchRequestStart.$2", "type": "Object", + "tags": [], "label": "options", - "isRequired": false, + "description": [], "signature": [ { "pluginId": "data", @@ -4529,28 +5048,21 @@ }, " | undefined" ], - "description": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_configs.ts", "lineNumber": 330 - } + }, + "deprecated": false, + "isRequired": false } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/data/common/search/aggs/agg_configs.ts", - "lineNumber": 330 - } + "returnComment": [] } ], - "source": { - "path": "src/plugins/data/common/search/aggs/agg_configs.ts", - "lineNumber": 65 - }, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.AggParamType", "type": "Class", "tags": [], @@ -4574,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": [], @@ -4651,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": [], @@ -4743,14 +5278,20 @@ }, "" ], + "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" @@ -4758,40 +5299,46 @@ "source": { "path": "src/plugins/data/common/search/aggs/agg_type.ts", "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": 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": 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" @@ -4799,15 +5346,17 @@ "source": { "path": "src/plugins/data/common/search/aggs/agg_type.ts", "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" @@ -4815,15 +5364,17 @@ "source": { "path": "src/plugins/data/common/search/aggs/agg_type.ts", "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" @@ -4831,67 +5382,75 @@ "source": { "path": "src/plugins/data/common/search/aggs/agg_type.ts", "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": 103 }, - "signature": [ - "\"string\" | \"number\" | \"boolean\" | \"object\" | \"date\" | \"ip\" | \"unknown\" | \"_source\" | \"attachment\" | \"geo_point\" | \"geo_shape\" | \"murmur3\" | \"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": 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": 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" @@ -4899,14 +5458,16 @@ "source": { "path": "src/plugins/data/common/search/aggs/agg_type.ts", "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" @@ -4914,127 +5475,137 @@ "source": { "path": "src/plugins/data/common/search/aggs/agg_type.ts", "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": 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": 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": 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": 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": 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": 194 }, - "signature": [ - "PostFlightRequestFn" - ] + "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": 204 - }, "signature": [ "(agg: TAggConfig) => ", { @@ -5045,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": 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": 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": 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": 210 - }, - "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": 214 - } + }, + "deprecated": false, + "isRequired": true } ], - "signature": [ - "(agg: TAggConfig) => string" - ], - "description": [], - "label": "getValueBucketPath", - "source": { - "path": "src/plugins/data/common/search/aggs/agg_type.ts", - "lineNumber": 214 - }, - "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", @@ -5171,43 +5775,39 @@ }, ">" ], - "description": [ - "- used to set the properties of the AggType" - ], "source": { "path": "src/plugins/data/common/search/aggs/agg_type.ts", "lineNumber": 227 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [ - "class", - "private" - ], - "returnComment": [], - "source": { - "path": "src/plugins/data/common/search/aggs/agg_type.ts", - "lineNumber": 227 - } + "returnComment": [] } ], - "source": { - "path": "src/plugins/data/common/search/aggs/agg_type.ts", - "lineNumber": 64 - }, "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": [], @@ -5279,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?: ", { @@ -5369,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) => ", { @@ -5419,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<", { @@ -5479,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": [], @@ -5551,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", @@ -5640,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": [], @@ -5755,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", @@ -5796,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: ", @@ -5884,33 +6543,51 @@ }, "[]" ], - "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": [], - "returnComment": [] - } - ], - "source": { - "path": "src/plugins/data/common/search/aggs/param_types/field.ts", - "lineNumber": 26 - }, - "initialIsOpen": false - }, - { - "id": "def-common.InvalidEsCalendarIntervalError", - "type": "Class", - "tags": [], - "label": "InvalidEsCalendarIntervalError", - "description": [], - "signature": [ - { - "pluginId": "data", + "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": [] + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "data", + "id": "def-common.InvalidEsCalendarIntervalError", + "type": "Class", + "tags": [], + "label": "InvalidEsCalendarIntervalError", + "description": [], + "signature": [ + { + "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.InvalidEsCalendarIntervalError", @@ -5918,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": [], @@ -6015,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": [], @@ -6163,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": [], @@ -6234,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": [], @@ -6357,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", @@ -6377,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": [], @@ -6442,17 +7184,19 @@ "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": [], - "source": { - "path": "src/plugins/data/common/search/search_source/fetch/request_error.ts", - "lineNumber": 19 - }, "signature": [ { "pluginId": "data", @@ -6462,22 +7206,36 @@ "text": "IKibanaSearchResponse" }, " | undefined" - ] + ], + "source": { + "path": "src/plugins/data/common/search/search_source/fetch/request_error.ts", + "lineNumber": 19 + }, + "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", @@ -6488,17 +7246,20 @@ }, " | 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": [ { "pluginId": "data", @@ -6509,64 +7270,71 @@ }, " | 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": 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", @@ -6576,17 +7344,20 @@ "text": "SearchSourceFields" } ], - "description": [], "source": { "path": "src/plugins/data/common/search/search_source/search_source.ts", "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", @@ -6596,57 +7367,63 @@ "text": "SearchSourceDependencies" } ], - "description": [], "source": { "path": "src/plugins/data/common/search/search_source/search_source.ts", "lineNumber": 133 - } + }, + "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.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": 151 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/data/common/search/search_source/search_source.ts", - "lineNumber": 151 - } + "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: ", { @@ -6658,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": 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", @@ -6693,61 +7479,67 @@ }, "[K]" ], - "description": [ - ": value for the field" - ], "source": { "path": "src/plugins/data/common/search/search_source/search_source.ts", "lineNumber": 160 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/data/common/search/search_source/search_source.ts", - "lineNumber": 160 - } + "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": 172 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/data/common/search/search_source/search_source.ts", - "lineNumber": 172 - } + "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: ", { @@ -6759,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", @@ -6777,46 +7575,45 @@ "text": "SearchSourceFields" } ], - "description": [ - "New field array." - ], "source": { "path": "src/plugins/data/common/search/search_source/search_source.ts", "lineNumber": 183 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [ - "private" - ], - "returnComment": [], - "source": { - "path": "src/plugins/data/common/search/search_source/search_source.ts", - "lineNumber": 183 - } + "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": 191 - } + }, + "deprecated": false, + "children": [], + "returnComment": [] }, { + "parentPluginId": "data", "id": "def-common.SearchSource.getFields", "type": "Function", + "tags": [], "label": "getFields", + "description": [ + "\nreturns all search source fields" + ], "signature": [ "() => ", { @@ -6827,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": 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) => ", { @@ -6853,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": 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": 205 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/data/common/search/search_source/search_source.ts", - "lineNumber": 205 - } + "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) => ", { @@ -6908,37 +7715,42 @@ }, "[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": 216 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/data/common/search/search_source/search_source.ts", - "lineNumber": 216 - } + "returnComment": [] }, { + "parentPluginId": "data", "id": "def-common.SearchSource.create", "type": "Function", - "label": "create", - "signature": [ + "tags": [ + "deprecated" + ], + "label": "create", + "description": [], + "signature": [ "() => ", { "pluginId": "data", @@ -6948,21 +7760,39 @@ "text": "SearchSource" } ], - "description": [], - "children": [], - "tags": [ - "deprecated" - ], - "returnComment": [], "source": { "path": "src/plugins/data/common/search/search_source/search_source.ts", "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": [ "() => ", { @@ -6973,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": 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?: {}) => ", { @@ -6998,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": 244 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/data/common/search/search_source/search_source.ts", - "lineNumber": 244 - } + "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<", { @@ -7047,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<", { @@ -7067,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": 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", @@ -7089,30 +7937,29 @@ "text": "SearchSourceOptions" } ], - "description": [ - "- the inherit options" - ], "source": { "path": "src/plugins/data/common/search/search_source/search_source.ts", "lineNumber": 256 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [ - "return" - ], "returnComment": [ "- chainable" - ], - "source": { - "path": "src/plugins/data/common/search/search_source/search_source.ts", - "lineNumber": 256 - } + ] }, { + "parentPluginId": "data", "id": "def-common.SearchSource.getParent", "type": "Function", + "tags": [ + "return" + ], "label": "getParent", + "description": [ + "\nGet the parent of this SearchSource" + ], "signature": [ "() => ", { @@ -7124,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": 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?: ", { @@ -7164,15 +8011,19 @@ "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", @@ -7182,24 +8033,27 @@ "text": "ISearchOptions" } ], - "description": [], "source": { "path": "src/plugins/data/common/search/search_source/search_source.ts", "lineNumber": 275 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/data/common/search/search_source/search_source.ts", - "lineNumber": 274 - } + "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?: ", { @@ -7213,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", @@ -7231,26 +8126,27 @@ "text": "ISearchOptions" } ], - "description": [], "source": { "path": "src/plugins/data/common/search/search_source/search_source.ts", "lineNumber": 312 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [ - "deprecated" - ], - "returnComment": [], - "source": { - "path": "src/plugins/data/common/search/search_source/search_source.ts", - "lineNumber": 312 - } + "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: ", { @@ -7270,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: ", { @@ -7298,64 +8198,67 @@ }, " | undefined) => Promise" ], - "description": [], "source": { "path": "src/plugins/data/common/search/search_source/search_source.ts", "lineNumber": 326 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [ - "return" - ], - "returnComment": [], - "source": { - "path": "src/plugins/data/common/search/search_source/search_source.ts", - "lineNumber": 325 - } + "returnComment": [] }, { + "parentPluginId": "data", "id": "def-common.SearchSource.getSearchRequestBody", "type": "Function", + "tags": [], "label": "getSearchRequestBody", - "signature": [ - "() => any" - ], "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": 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": 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) => ", { @@ -7366,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": 826 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/data/common/search/search_source/search_source.ts", - "lineNumber": 826 - } + "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": 855 - } - } - ], - "source": { - "path": "src/plugins/data/common/search/search_source/search_source.ts", - "lineNumber": 121 - }, + }, + "deprecated": false, + "children": [], + "returnComment": [] + } + ], "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<", { @@ -7490,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<", { @@ -7508,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", @@ -7528,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": [], @@ -7597,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 }: ", { @@ -8335,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", @@ -8351,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", @@ -8398,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<", { @@ -8460,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", @@ -8480,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 } ], - "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 }, { + "parentPluginId": "data", "id": "def-common.dateHistogramInterval", "type": "Function", + "tags": [], "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." ], + "signature": [ + "(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: ", { @@ -8621,50 +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.filtersToAst", - "type": "Function", + "deprecated": false, "children": [ { - "id": "def-common.filtersToAst.$1", - "type": "CompoundType", - "label": "filters", - "isRequired": true, + "parentPluginId": "data", + "id": "def-common.extractReferences.$1", + "type": "Object", + "tags": [], + "label": "state", + "description": [], "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" - }, - "[]" + "docId": "kibDataSearchPluginApi", + "section": "def-common.SearchSourceFields", + "text": "SearchSourceFields" + } ], - "description": [], "source": { - "path": "src/plugins/data/common/search/expressions/filters_to_ast.ts", - "lineNumber": 13 - } + "path": "src/plugins/data/common/search/search_source/extract_references.ts", + "lineNumber": 14 + }, + "deprecated": false, + "isRequired": true } ], + "returnComment": [], + "initialIsOpen": false + }, + { + "parentPluginId": "data", + "id": "def-common.filtersToAst", + "type": "Function", + "tags": [], + "label": "filtersToAst", + "description": [], "signature": [ "(filters: ", { @@ -8692,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: ", { @@ -8756,22 +9782,46 @@ "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": [], + "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", - "children": [], + "tags": [], + "label": "getAvgMetricAgg", + "description": [], "signature": [ "() => ", { @@ -8791,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": [ "() => ", { @@ -8824,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": [ "() => ", { @@ -8857,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": [ "() => ", { @@ -8890,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": [ "() => ", { @@ -8923,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: ", { @@ -8948,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": [ "() => ", { @@ -8996,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": [ "() => ", { @@ -9029,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": [ "() => ", { @@ -9062,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, }: ", { @@ -9124,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: ", { @@ -9178,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, }: ", { @@ -9242,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": [ "() => ", { @@ -9275,50 +10361,22 @@ }, ">" ], - "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 - } - } - ], + "tags": [], + "label": "getEsdslFn", + "description": [], "signature": [ "({ getStartDependencies, }: { getStartDependencies: (getKibanaRequest: any) => Promise<", "EsdslStartDependencies", @@ -9331,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": [], - "source": { - "path": "src/plugins/data/common/search/aggs/buckets/filter.ts", - "lineNumber": 27 - }, "signature": [ - "(key: string) => any" - ] + "(getKibanaRequest: any) => Promise<", + "EsdslStartDependencies", + ">" + ], + "source": { + "path": "src/plugins/data/common/search/expressions/esdsl.ts", + "lineNumber": 45 + }, + "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; }) => ", { @@ -9392,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": [ "() => ", { @@ -9425,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 }: ", { @@ -9487,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": [ "() => ", { @@ -9520,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": [ "() => ", { @@ -9553,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": [ "() => ", { @@ -9586,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": [ "() => ", { @@ -9611,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, }: ", { @@ -9673,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": [ "() => ", { @@ -9706,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: (() => ", { @@ -9765,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": [ "() => ", { @@ -9798,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": [ "() => ", { @@ -9831,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": [ "() => ", { @@ -9864,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": [ "() => ", { @@ -9897,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: ", @@ -9943,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, }: ", { @@ -10001,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": [ "() => ", { @@ -10028,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: ", { @@ -10053,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", @@ -10069,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 }: ", { @@ -10136,20 +11267,46 @@ }, ">" ], - "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 }, { + "parentPluginId": "data", "id": "def-common.getResponseInspectorStats", "type": "Function", + "tags": [], "label": "getResponseInspectorStats", + "description": [], "signature": [ "(resp: ", "SearchResponse", @@ -10170,28 +11327,37 @@ "text": "RequestStatistics" } ], - "description": [], + "source": { + "path": "src/plugins/data/common/search/search_source/inspect/inspector_stats.ts", + "lineNumber": 52 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-common.getResponseInspectorStats.$1", "type": "Object", + "tags": [], "label": "resp", - "isRequired": false, + "description": [], "signature": [ "SearchResponse", " | undefined" ], - "description": [], "source": { "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<", { @@ -10203,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/search_source/inspect/inspector_stats.ts", "lineNumber": 54 - } + }, + "deprecated": false, + "isRequired": false } ], - "tags": [ - "public" - ], "returnComment": [], - "source": { - "path": "src/plugins/data/common/search/search_source/inspect/inspector_stats.ts", - "lineNumber": 52 - }, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.getSearchParams", "type": "Function", + "tags": [], "label": "getSearchParams", + "description": [], "signature": [ "(getConfig: ", { @@ -10235,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", @@ -10251,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: ", { @@ -10288,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", @@ -10329,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 - } + ], + "source": { + "path": "src/plugins/data/common/search/search_source/fetch/get_search_params.ts", + "lineNumber": 35 + }, + "deprecated": false + } + ] } ], - "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": [ "() => ", { @@ -10371,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": [ "() => ", { @@ -10404,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": [ "() => ", { @@ -10437,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": [ "() => ", { @@ -10470,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": [ "() => ", { @@ -10503,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": [ "() => ", { @@ -10536,20 +11721,22 @@ }, ">" ], - "description": [], - "label": "getTermsBucketAgg", "source": { "path": "src/plugins/data/common/search/aggs/buckets/terms.ts", "lineNumber": 63 }, - "tags": [], + "deprecated": false, + "children": [], "returnComment": [], "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.getTopHitMetricAgg", "type": "Function", - "children": [], + "tags": [], + "label": "getTopHitMetricAgg", + "description": [], "signature": [ "() => ", { @@ -10561,35 +11748,22 @@ }, "" ], - "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 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": 43 - } - } - ], + "tags": [], + "label": "handleRequest", + "description": [], "signature": [ "({ abortSignal, aggs, filters, indexPattern, inspectorAdapters, partialRows, query, searchSessionId, searchSourceService, timeFields, timeRange, getNow, }: ", "RequestHandlerParams", @@ -10603,20 +11777,40 @@ }, ">" ], - "description": [], - "label": "handleRequest", "source": { "path": "src/plugins/data/common/search/expressions/esaggs/request_handler.ts", "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: ", { @@ -10636,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", @@ -10652,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", @@ -10672,58 +11875,91 @@ "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", + "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-common.injectReferences.$1", "type": "CompoundType", + "tags": [], "label": "searchSourceFields", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "data", @@ -10734,131 +11970,140 @@ }, " & { 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", @@ -10869,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", @@ -10950,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: ", { @@ -11033,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", @@ -11054,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: ", { @@ -11105,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: ", { @@ -11128,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: ", { @@ -11160,187 +12402,215 @@ }, ") => 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", - "children": [ - { - "id": "def-common.parseSearchSourceJSON.$1", - "type": "string", - "label": "searchSourceJSON", - "isRequired": true, - "signature": [ - "string" - ], - "description": [], - "source": { - "path": "src/plugins/data/common/search/search_source/parse_json.ts", - "lineNumber": 12 - } - } - ], + "tags": [], + "label": "parseSearchSourceJSON", + "description": [], "signature": [ "(searchSourceJSON: string) => ", { @@ -11351,53 +12621,108 @@ "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-common.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 }, { + "parentPluginId": "data", "id": "def-common.pollSearch", "type": "Function", + "tags": [], + "label": "pollSearch", + "description": [], + "signature": [ + ">(search: () => Promise, cancel?: (() => void) | undefined, { pollInterval, abortSignal }?: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.IAsyncSearchOptions", + "text": "IAsyncSearchOptions" + }, + ") => ", + "Observable", + "" + ], + "source": { + "path": "src/plugins/data/common/search/poll_search.ts", + "lineNumber": 18 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-common.pollSearch.$1", "type": "Function", + "tags": [], "label": "search", - "isRequired": true, + "description": [], "signature": [ "() => Promise" ], - "description": [], "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", - "isRequired": false, + "description": [], "signature": [ "(() => void) | undefined" ], - "description": [], "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 }", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "data", @@ -11407,105 +12732,65 @@ "text": "IAsyncSearchOptions" } ], - "description": [], "source": { "path": "src/plugins/data/common/search/poll_search.ts", "lineNumber": 21 - } + }, + "deprecated": false, + "isRequired": true } ], - "signature": [ - ">(search: () => Promise, cancel?: (() => void) | undefined, { pollInterval, abortSignal }?: ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.IAsyncSearchOptions", - "text": "IAsyncSearchOptions" - }, - ") => ", - "Observable", - "" - ], - "description": [], - "label": "pollSearch", - "source": { - "path": "src/plugins/data/common/search/poll_search.ts", - "lineNumber": 18 - }, - "tags": [], "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: ", { @@ -11524,54 +12809,87 @@ "text": "ExpressionAstExpressionBuilder" } ], - "description": [], - "label": "queryToAst", "source": { "path": "src/plugins/data/common/search/expressions/query_to_ast.ts", "lineNumber": 14 }, - "tags": [], + "deprecated": false, + "children": [ + { + "parentPluginId": "data", + "id": "def-common.queryToAst.$1", + "type": "Object", + "tags": [], + "label": "query", + "description": [], + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataQueryPluginApi", + "section": "def-common.Query", + "text": "Query" + } + ], + "source": { + "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" + ], + "source": { + "path": "src/plugins/data/common/search/aggs/utils/date_interval_utils/parse_interval.ts", + "lineNumber": 16 + }, + "deprecated": false, "children": [ { + "parentPluginId": "data", "id": "def-common.splitStringInterval.$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": 16 - } + }, + "deprecated": false, + "isRequired": true } ], - "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 }, { + "parentPluginId": "data", "id": "def-common.tabifyAggResponse", "type": "Function", + "tags": [], "label": "tabifyAggResponse", + "description": [ + "\nSets up the ResponseWriter and kicks off bucket collection." + ], "signature": [ "(aggConfigs: ", { @@ -11592,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", @@ -11610,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", @@ -11689,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: ", { @@ -11759,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", @@ -11778,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: ", { @@ -11863,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: ", { @@ -11888,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", @@ -11904,590 +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 }, - "signature": [ - "AggTypesRegistryStart" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.AggConfigsOptions.hierarchical", "type": "CompoundType", + "tags": [], "label": "hierarchical", "description": [], + "signature": [ + "boolean | undefined" + ], "source": { "path": "src/plugins/data/common/search/aggs/agg_configs.ts", "lineNumber": 46 }, - "signature": [ - "boolean | undefined" - ] + "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": [], - "source": { - "path": "src/plugins/data/common/search/aggs/types.ts", - "lineNumber": 213 - }, "signature": [ "FunctionDefinition" - ] + ], + "source": { + "path": "src/plugins/data/common/search/aggs/types.ts", + "lineNumber": 213 + }, + "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: ", { @@ -12499,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", @@ -12515,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", @@ -12551,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", @@ -12587,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", @@ -12644,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": 17 - }, + ], + "source": { + "path": "src/plugins/data/common/search/aggs/metrics/bucket_max.ts", + "lineNumber": 19 + }, + "deprecated": false + } + ], "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.AggParamsBucketMin", "type": "Interface", + "tags": [], "label": "AggParamsBucketMin", + "description": [], "signature": [ { "pluginId": "data", @@ -12701,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", @@ -12758,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", @@ -12815,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", @@ -12851,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", @@ -12920,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 | ", { @@ -12943,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", @@ -12964,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", @@ -13129,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", @@ -13165,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", @@ -13203,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", @@ -13272,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", @@ -13311,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", @@ -13369,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: ", { @@ -13392,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", @@ -13416,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", @@ -13452,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", @@ -13488,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", @@ -13594,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", @@ -13658,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", @@ -13793,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", @@ -13826,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: ", { @@ -13856,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", @@ -13880,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", @@ -13916,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", @@ -13952,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", @@ -13988,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", @@ -14085,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", @@ -14135,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", @@ -14185,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", @@ -14235,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", @@ -14304,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", @@ -14382,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", @@ -14429,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", @@ -14465,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", @@ -14501,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": 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": 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": 51 - }, "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": 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": 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": 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": 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": 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": 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": 59 }, - "signature": [ - "string | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.AggParamsTerms.include", "type": "string", + "tags": [], "label": "include", "description": [], + "signature": [ + "string | undefined" + ], "source": { "path": "src/plugins/data/common/search/aggs/buckets/terms.ts", "lineNumber": 60 }, - "signature": [ - "string | undefined" - ] + "deprecated": false } ], - "source": { - "path": "src/plugins/data/common/search/aggs/buckets/terms.ts", - "lineNumber": 48 - }, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.AggParamsTopHit", "type": "Interface", + "tags": [], "label": "AggParamsTopHit", + "description": [], "signature": [ { "pluginId": "data", @@ -14676,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", @@ -14767,262 +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": 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": 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": 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": 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": 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": 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": 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": 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": 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": 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": 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": 48 }, - "signature": [ - "\"string\" | \"number\" | \"boolean\" | \"object\" | \"date\" | \"ip\" | \"unknown\" | \"_source\" | \"attachment\" | \"geo_point\" | \"geo_shape\" | \"murmur3\" | \"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": 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": 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": 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": 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": 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": 54 }, - "signature": [ - "PostFlightRequestFn | 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": 55 - }, "signature": [ "((agg: TAggConfig) => ", { @@ -15033,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": 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": 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": 58 }, - "signature": [ - "((agg: TAggConfig) => string) | undefined" - ] + "deprecated": false } ], - "source": { - "path": "src/plugins/data/common/search/aggs/agg_type.ts", - "lineNumber": 33 - }, "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", @@ -15142,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", @@ -15186,198 +16945,228 @@ "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 } ], - "source": { - "path": "src/plugins/data/common/search/aggs/buckets/lib/date_range.ts", - "lineNumber": 9 - }, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.EqlSearchStrategyRequest", "type": "Interface", + "tags": [], "label": "EqlSearchStrategyRequest", + "description": [], "signature": [ { "pluginId": "data", @@ -15404,35 +17193,39 @@ }, ">" ], - "description": [], - "tags": [], + "source": { + "path": "src/plugins/data/common/search/strategies/eql_search/types.ts", + "lineNumber": 18 + }, + "deprecated": false, "children": [ { - "tags": [], + "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 }, - "signature": [ - "TransportRequestOptions", - " | undefined" - ] + "deprecated": false } ], - "source": { - "path": "src/plugins/data/common/search/strategies/eql_search/types.ts", - "lineNumber": 18 - }, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.EsRawResponse", "type": "Interface", + "tags": [], "label": "EsRawResponse", + "description": [], "signature": [ { "pluginId": "data", @@ -15443,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": [], + "signature": [ + "SearchResponse", + "" + ], "source": { "path": "src/plugins/data/common/search/expressions/es_raw_response.ts", "lineNumber": 16 }, - "signature": [ - "SearchResponse", - "" - ] + "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": 22 - }, "signature": [ { "pluginId": "data", @@ -15507,20 +17306,22 @@ "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": 27 - }, "signature": [ "(request: Record, response: ", { @@ -15539,74 +17340,84 @@ "text": "IKibanaSearchResponse" }, "" - ] + ], + "source": { + "path": "src/plugins/data/common/search/search_source/fetch/types.ts", + "lineNumber": 27 + }, + "deprecated": false } ], - "source": { - "path": "src/plugins/data/common/search/search_source/fetch/types.ts", - "lineNumber": 21 - }, "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 } ], - "source": { - "path": "src/plugins/data/common/search/aggs/buckets/histogram.ts", - "lineNumber": 30 - }, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.IAsyncSearchOptions", "type": "Interface", + "tags": [], "label": "IAsyncSearchOptions", + "description": [], "signature": [ { "pluginId": "data", @@ -15647,36 +17462,40 @@ "text": "ISearchOptions" } ], - "description": [], - "tags": [], + "source": { + "path": "src/plugins/data/common/search/strategies/ese_search/types.ts", + "lineNumber": 13 + }, + "deprecated": false, "children": [ { - "tags": [], + "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 }, - "signature": [ - "number | undefined" - ] + "deprecated": false } ], - "source": { - "path": "src/plugins/data/common/search/strategies/ese_search/types.ts", - "lineNumber": 13 - }, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.IBucketAggConfig", "type": "Interface", + "tags": [], "label": "IBucketAggConfig", + "description": [], "signature": [ { "pluginId": "data", @@ -15694,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", @@ -15724,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", @@ -15754,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", @@ -15799,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: ", { @@ -15822,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": [ "() => ", { @@ -15843,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", @@ -15882,47 +17715,51 @@ }, ">" ], - "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/strategies/es_search/types.ts", "lineNumber": 19 }, - "signature": [ - "string | undefined" - ] + "deprecated": false } ], - "source": { - "path": "src/plugins/data/common/search/strategies/es_search/types.ts", - "lineNumber": 18 - }, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.IInspectorInfo", "type": "Interface", + "tags": [], "label": "IInspectorInfo", "description": [], - "tags": [], + "source": { + "path": "src/plugins/data/common/search/types.ts", + "lineNumber": 83 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "data", "id": "def-common.IInspectorInfo.adapter", "type": "Object", + "tags": [], "label": "adapter", "description": [], - "source": { - "path": "src/plugins/data/common/search/types.ts", - "lineNumber": 84 - }, "signature": [ { "pluginId": "inspector", @@ -15932,58 +17769,68 @@ "text": "RequestAdapter" }, " | undefined" - ] + ], + "source": { + "path": "src/plugins/data/common/search/types.ts", + "lineNumber": 84 + }, + "deprecated": false }, { - "tags": [], + "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 }, { - "tags": [], + "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 }, - "signature": [ - "string | undefined" - ] + "deprecated": false }, { - "tags": [], + "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 }, - "signature": [ - "string | undefined" - ] + "deprecated": false } ], - "source": { - "path": "src/plugins/data/common/search/types.ts", - "lineNumber": 83 - }, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.IKibanaSearchRequest", "type": "Interface", + "tags": [], "label": "IKibanaSearchRequest", + "description": [], "signature": [ { "pluginId": "data", @@ -15994,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", @@ -16048,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" - ] - } - ], - "source": { - "path": "src/plugins/data/common/search/types.ts", - "lineNumber": 40 - }, + "deprecated": false + } + ], "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.IMetricAggConfig", "type": "Interface", + "tags": [], "label": "IMetricAggConfig", + "description": [], "signature": [ { "pluginId": "data", @@ -16175,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", @@ -16205,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", @@ -16239,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", @@ -16261,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", @@ -16283,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": 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": 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`." ], + "signature": [ + "boolean | undefined" + ], "source": { "path": "src/plugins/data/common/search/types.ts", "lineNumber": 105 }, - "signature": [ - "boolean | undefined" - ] + "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": 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": 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": 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": 126 - }, "signature": [ { "pluginId": "data", @@ -16416,20 +18307,22 @@ "text": "IndexPattern" }, " | undefined" - ] + ], + "source": { + "path": "src/plugins/data/common/search/types.ts", + "lineNumber": 126 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.ISearchOptions.inspector", "type": "Object", + "tags": [], "label": "inspector", "description": [ "\nInspector integration options" ], - "source": { - "path": "src/plugins/data/common/search/types.ts", - "lineNumber": 131 - }, "signature": [ { "pluginId": "data", @@ -16439,38 +18332,40 @@ "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": 90 - }, "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": 31 - }, "signature": [ "(fields?: ", { @@ -16489,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": 35 - }, "signature": [ "() => Pick<", { @@ -16513,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": 26 - }, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.IStdDevAggConfig", "type": "Interface", + "tags": [], "label": "IStdDevAggConfig", + "description": [], "signature": [ { "pluginId": "data", @@ -16537,48 +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": [], + "signature": [ + "() => string[]" + ], "source": { "path": "src/plugins/data/common/search/aggs/metrics/std_deviation.ts", "lineNumber": 29 }, - "signature": [ - "() => string[]" - ] + "deprecated": false } ], - "source": { - "path": "src/plugins/data/common/search/aggs/metrics/std_deviation.ts", - "lineNumber": 27 - }, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.MetricAggParam", "type": "Interface", + "tags": [], "label": "MetricAggParam", + "description": [], "signature": [ { "pluginId": "data", @@ -16597,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", @@ -16627,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": 23 }, - "signature": [ - "MsearchRequest[]" - ] + "deprecated": false } ], - "source": { - "path": "src/plugins/data/common/search/search_source/legacy/types.ts", - "lineNumber": 22 - }, "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": 28 - }, "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": 27 - }, "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: ", { @@ -16772,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": 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": 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": 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": 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": 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": 137 }, - "signature": [ - "string[]" - ] + "deprecated": false } ], - "source": { - "path": "src/plugins/data/common/search/search_source/types.ts", - "lineNumber": 131 - }, "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": 141 - }, "signature": [ "{ failed: number; failures: ", { @@ -17028,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": 140 - }, "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": 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": 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": 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": 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": 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": 36 - } + }, + "deprecated": false } ], - "source": { - "path": "src/plugins/data/common/search/search_source/fetch/types.ts", - "lineNumber": 30 - }, "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": [], + "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" @@ -17219,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" @@ -17232,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" @@ -17245,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" @@ -17331,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" @@ -17344,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." @@ -17357,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", @@ -17395,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." @@ -17480,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", @@ -17554,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": 117 - }, "signature": [ { "pluginId": "data", @@ -17575,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": 116 - }, "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": 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": 75 - }, "signature": [ { "pluginId": "data", @@ -17628,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": 79 - }, "signature": [ { "pluginId": "data", @@ -17675,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": 83 - }, + ], "signature": [ "Record object) | undefined" - ] + ], + "source": { + "path": "src/plugins/data/common/search/search_source/types.ts", + "lineNumber": 90 + }, + "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": 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": 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": 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": 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": 98 - }, "signature": [ { "pluginId": "data", @@ -17875,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": 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": 108 - }, "signature": [ { "pluginId": "data", @@ -17916,18 +19999,20 @@ "text": "IndexPattern" }, " | undefined" - ] + ], + "source": { + "path": "src/plugins/data/common/search/search_source/types.ts", + "lineNumber": 108 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.SearchSourceFields.searchAfter", "type": "Object", + "tags": [], "label": "searchAfter", "description": [], - "source": { - "path": "src/plugins/data/common/search/search_source/types.ts", - "lineNumber": 109 - }, "signature": [ { "pluginId": "data", @@ -17937,46 +20022,52 @@ "text": "EsQuerySearchAfter" }, " | undefined" - ] + ], + "source": { + "path": "src/plugins/data/common/search/search_source/types.ts", + "lineNumber": 109 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.SearchSourceFields.timeout", "type": "string", + "tags": [], "label": "timeout", "description": [], + "signature": [ + "string | undefined" + ], "source": { "path": "src/plugins/data/common/search/search_source/types.ts", "lineNumber": 110 }, - "signature": [ - "string | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.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": 111 }, - "signature": [ - "number | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.SearchSourceFields.parent", "type": "Object", + "tags": [], "label": "parent", "description": [], - "source": { - "path": "src/plugins/data/common/search/search_source/types.ts", - "lineNumber": 113 - }, "signature": [ { "pluginId": "data", @@ -17986,121 +20077,139 @@ "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": 70 - }, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.SearchSourceOptions", "type": "Interface", + "tags": [], "label": "SearchSourceOptions", "description": [], - "tags": [], + "source": { + "path": "src/plugins/data/common/search/search_source/types.ts", + "lineNumber": 116 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "data", "id": "def-common.SearchSourceOptions.callParentStartHandlers", "type": "CompoundType", + "tags": [], "label": "callParentStartHandlers", "description": [], + "signature": [ + "boolean | undefined" + ], "source": { "path": "src/plugins/data/common/search/search_source/types.ts", "lineNumber": 117 }, - "signature": [ - "boolean | undefined" - ] + "deprecated": false } ], - "source": { - "path": "src/plugins/data/common/search/search_source/types.ts", - "lineNumber": 116 - }, "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": 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": 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": 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": 164 - } + }, + "deprecated": false } ], - "source": { - "path": "src/plugins/data/common/search/search_source/types.ts", - "lineNumber": 150 - }, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.SortDirectionFormat", "type": "Interface", + "tags": [], "label": "SortDirectionFormat", "description": [], - "tags": [], + "source": { + "path": "src/plugins/data/common/search/search_source/types.ts", + "lineNumber": 45 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "data", "id": "def-common.SortDirectionFormat.order", "type": "Enum", + "tags": [], "label": "order", "description": [], - "source": { - "path": "src/plugins/data/common/search/search_source/types.ts", - "lineNumber": 46 - }, "signature": [ { "pluginId": "data", @@ -18109,46 +20218,52 @@ "section": "def-common.SortDirection", "text": "SortDirection" } - ] + ], + "source": { + "path": "src/plugins/data/common/search/search_source/types.ts", + "lineNumber": 46 + }, + "deprecated": false }, { - "tags": [], + "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 }, - "signature": [ - "string | undefined" - ] + "deprecated": false } ], - "source": { - "path": "src/plugins/data/common/search/search_source/types.ts", - "lineNumber": 45 - }, "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": 51 - }, "signature": [ { "pluginId": "data", @@ -18157,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": 52 }, - "signature": [ - "\"date\" | \"long\" | \"double\" | \"date_nanos\" | undefined" - ] + "deprecated": false } ], - "source": { - "path": "src/plugins/data/common/search/search_source/types.ts", - "lineNumber": 50 - }, "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": 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": 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": 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": 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": 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": 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": 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": 128 }, - "signature": [ - "object | undefined" - ] + "deprecated": false } ], - "source": { - "path": "src/plugins/data/common/search/search_source/types.ts", - "lineNumber": 120 - }, "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": 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: ", { @@ -18908,215 +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": 49 - }, "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 }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.ENHANCED_ES_SEARCH_STRATEGY", "type": "string", + "tags": [], "label": "ENHANCED_ES_SEARCH_STRATEGY", "description": [], + "signature": [ + "\"ese\"" + ], "source": { "path": "src/plugins/data/common/search/strategies/ese_search/types.ts", "lineNumber": 11 }, - "signature": [ - "\"ese\"" - ], + "deprecated": false, "initialIsOpen": false }, { - "tags": [], + "parentPluginId": "data", "id": "def-common.EQL_SEARCH_STRATEGY", "type": "string", + "tags": [], "label": "EQL_SEARCH_STRATEGY", "description": [], + "signature": [ + "\"eql\"" + ], "source": { "path": "src/plugins/data/common/search/strategies/eql_search/types.ts", "lineNumber": 14 }, - "signature": [ - "\"eql\"" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.EqlRequestParams", "type": "Type", - "label": "EqlRequestParams", "tags": [], + "label": "EqlRequestParams", "description": [], + "signature": [ + "EqlSearch>" + ], "source": { "path": "src/plugins/data/common/search/strategies/eql_search/types.ts", "lineNumber": 16 }, - "signature": [ - "EqlSearch>" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.EqlSearchStrategyResponse", "type": "Type", - "label": "EqlSearchStrategyResponse", "tags": [], + "label": "EqlSearchStrategyResponse", "description": [], + "signature": [ + "IKibanaSearchResponse>" + ], "source": { "path": "src/plugins/data/common/search/strategies/eql_search/types.ts", "lineNumber": 22 }, - "signature": [ - "IKibanaSearchResponse>" - ], + "deprecated": false, "initialIsOpen": false }, { - "tags": [], + "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/strategies/es_search/types.ts", "lineNumber": 12 }, - "signature": [ - "\"es\"" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.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, ", { @@ -19138,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\", ", { @@ -19186,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": 38 - }, "signature": [ "[", "ReactText", @@ -19205,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": 55 }, - "signature": [ - "{ [x: string]: SortDirection | SortDirectionNumeric | SortDirectionFormat; }" - ], + "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": [], + "label": "ExpressionFunctionExistsFilter", "description": [], - "source": { - "path": "src/plugins/data/common/search/expressions/exists_filter.ts", - "lineNumber": 20 - }, "signature": [ "ExpressionFunctionDefinition<\"existsFilter\", null, Arguments, ", { @@ -19298,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, ", { @@ -19346,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\", ", { @@ -19377,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\", ", { @@ -19408,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, ", { @@ -19456,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>, ", { @@ -19489,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, ", { @@ -19537,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, ", { @@ -19585,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, ", { @@ -19633,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>, ", { @@ -19666,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, ", { @@ -19714,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", @@ -19782,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": [], + "signature": [ + "AggType>" + ], "source": { "path": "src/plugins/data/common/search/aggs/agg_type.ts", "lineNumber": 62 }, - "signature": [ - "AggType>" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "data", "id": "def-common.IEsSearchResponse", "type": "Type", - "label": "IEsSearchResponse", "tags": [], + "label": "IEsSearchResponse", "description": [], + "signature": [ + "IKibanaSearchResponse>" + ], "source": { "path": "src/plugins/data/common/search/strategies/es_search/types.ts", "lineNumber": 22 }, - "signature": [ - "IKibanaSearchResponse>" - ], + "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: ", { @@ -19883,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", @@ -19942,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: ", { @@ -19965,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: ", { @@ -19988,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: ", { @@ -20013,54 +22308,58 @@ "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": 138 - }, "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": [], + "signature": [ + "{ trackTotalHits?: boolean | undefined; } & estypes.SearchRequest" + ], "source": { "path": "src/plugins/data/common/search/strategies/es_search/types.ts", "lineNumber": 14 }, - "signature": [ - "{ trackTotalHits?: boolean | undefined; } & estypes.SearchRequest" - ], + "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": 20 - }, "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?: ", { @@ -20091,309 +22390,392 @@ "text": "ISearchOptions" } ], + "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": [], + "signature": [ + "string | SearchField" + ], "source": { "path": "src/plugins/data/common/search/search_source/types.ts", "lineNumber": 65 }, - "signature": [ - "string | SearchField" - ], + "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": [], + "signature": [ + "string[]" + ], "source": { "path": "src/plugins/data/common/search/aggs/buckets/terms.ts", "lineNumber": 30 }, - "signature": [ - "string[]" - ], + "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", @@ -20404,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?: ", { @@ -20646,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) => ", { @@ -20929,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 }: ", { @@ -21092,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", @@ -21153,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: ", { @@ -21744,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", @@ -21774,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<", { @@ -22208,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": [ "() => ", { @@ -22249,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: ", { @@ -22273,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", @@ -22289,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?: ", { @@ -22576,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?: ", { @@ -22873,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[]) => ", { @@ -23236,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: ", { @@ -23275,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", @@ -23291,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 3175263de68db..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; 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 24403028ce405..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": 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 b5d33291ab4f2..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": [], - "children": [ + "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": 77 - }, "signature": [ "{ 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": 76 - }, "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": 88 - }, "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": 106 - }, "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": 87 - }, "lifecycle": "start", "initialIsOpen": true } @@ -883,198 +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 }, - "signature": [ - "\"fields:popularLimit\"" - ], + "deprecated": false, "initialIsOpen": false }, { - "tags": [], + "parentPluginId": "discover", "id": "def-common.MAX_DOC_FIELDS_DISPLAYED", "type": "string", + "tags": [], "label": "MAX_DOC_FIELDS_DISPLAYED", "description": [], + "signature": [ + "\"discover:maxDocFieldsDisplayed\"" + ], "source": { "path": "src/plugins/discover/common/index.ts", "lineNumber": 21 }, - "signature": [ - "\"discover:maxDocFieldsDisplayed\"" - ], + "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 bf9c79b5b0694..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": 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": 71 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "x-pack/plugins/discover_enhanced/public/plugin.ts", - "lineNumber": 71 - } + "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": 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; }; exploreDataInContextMenu: { 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 03d3f42cccbc9..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,54 +3882,62 @@ }, " | 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; openInNewTab?: boolean | undefined; state: ", { @@ -3521,69 +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 }, { - "tags": [], + "parentPluginId": "embeddable", "id": "def-public.EmbeddableStateTransfer.navigateToEditor.$2.options.openInNewTab", "type": "CompoundType", + "tags": [], "label": "openInNewTab", "description": [], + "signature": [ + "boolean | undefined" + ], "source": { "path": "src/plugins/embeddable/public/lib/state_transfer/embeddable_state_transfer.ts", "lineNumber": 118 }, - "signature": [ - "boolean | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "embeddable", "id": "def-public.EmbeddableStateTransfer.navigateToEditor.$2.options.state", "type": "Object", + "tags": [], "label": "state", "description": [], - "source": { - "path": "src/plugins/embeddable/public/lib/state_transfer/embeddable_state_transfer.ts", - "lineNumber": 119 - }, "signature": [ { "pluginId": "embeddable", @@ -3592,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: ", { @@ -3623,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": 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": 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": 134 - }, "signature": [ { "pluginId": "embeddable", @@ -3680,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": 134 - } + ] } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/embeddable/public/lib/state_transfer/embeddable_state_transfer.ts", - "lineNumber": 132 - } + "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": [], @@ -3743,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", @@ -3809,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", @@ -3846,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": [], @@ -3946,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 ", { @@ -4174,35 +4645,40 @@ }, ">>" ], - "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 } ], + "returnComment": [], + "initialIsOpen": false + }, + { + "parentPluginId": "embeddable", + "id": "def-public.isEmbeddable", + "type": "Function", + "tags": [], + "label": "isEmbeddable", + "description": [], "signature": [ "(x: unknown) => x is ", { @@ -4230,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: ", { @@ -4255,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", @@ -4272,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: ", { @@ -4379,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": [], - "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", + "deprecated": false, "children": [ { - "id": "def-public.isRowClickTriggerContext.$1", + "parentPluginId": "embeddable", + "id": "def-public.isRangeSelectTriggerContext.$1", "type": "CompoundType", + "tags": [], "label": "context", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "embeddable", @@ -4464,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: ", { @@ -4513,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: ", { @@ -4546,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", @@ -4570,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: ", { @@ -4677,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: ", { @@ -4733,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", @@ -4777,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<", { @@ -4883,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", @@ -4903,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", @@ -4923,70 +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 }, - "signature": [ - "React.ComponentType" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "embeddable", "id": "def-public.openAddPanelFlyout.$1.options.showCreateNewMenu", "type": "CompoundType", + "tags": [], "label": "showCreateNewMenu", "description": [], + "signature": [ + "boolean | undefined" + ], "source": { "path": "src/plugins/embeddable/public/lib/panel/panel_header/panel_actions/add_panel/open_add_panel_flyout.tsx", "lineNumber": 23 }, - "signature": [ - "boolean | undefined" - ] + "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", @@ -5062,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", @@ -5106,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]: ", { @@ -5151,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", @@ -5181,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", @@ -5272,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: ", { @@ -5310,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", @@ -5333,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", @@ -5412,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", @@ -5451,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": 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": 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": 50 - }, "signature": [ { "pluginId": "savedObjects", @@ -5502,20 +6091,22 @@ "text": "SavedObjectMetaData" }, " | undefined" - ] + ], + "source": { + "path": "src/plugins/embeddable/public/lib/embeddables/embeddable_factory.ts", + "lineNumber": 50 + }, + "deprecated": false }, { - "tags": [], + "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" ], - "source": { - "path": "src/plugins/embeddable/public/lib/embeddables/embeddable_factory.ts", - "lineNumber": 56 - }, "signature": [ { "pluginId": "uiActions", @@ -5525,12 +6116,18 @@ "text": "PresentableGrouping" }, " | undefined" - ] + ], + "source": { + "path": "src/plugins/embeddable/public/lib/embeddables/embeddable_factory.ts", + "lineNumber": 56 + }, + "deprecated": false }, { - "tags": [], + "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." @@ -5538,135 +6135,156 @@ "source": { "path": "src/plugins/embeddable/public/lib/embeddables/embeddable_factory.ts", "lineNumber": 64 - } + }, + "deprecated": false }, { + "parentPluginId": "embeddable", "id": "def-public.EmbeddableFactory.getDisplayName", "type": "Function", + "tags": [], "label": "getDisplayName", - "signature": [ - "() => string" - ], "description": [ "\nReturns a display name for this type of embeddable. Used in \"Create new... \" options\nin the add panel for containers." ], - "children": [], - "tags": [], - "returnComment": [], + "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", - "signature": [ - "() => string" - ], "description": [ "\nReturns an EUI Icon type to be displayed in a menu." ], - "children": [], - "tags": [], - "returnComment": [], + "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": [], "label": "getDescription", - "signature": [ - "() => string" - ], "description": [ "\nReturns a description about the embeddable." ], - "children": [], - "tags": [], - "returnComment": [], + "signature": [ + "() => string" + ], "source": { "path": "src/plugins/embeddable/public/lib/embeddables/embeddable_factory.ts", "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": 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": 94 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/embeddable/public/lib/embeddables/embeddable_factory.ts", - "lineNumber": 94 - } + "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": 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?: ", { @@ -5702,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": 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": 112 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "embeddable", "id": "def-public.EmbeddableFactory.createFromSavedObject.$3", "type": "Object", + "tags": [], "label": "parent", - "isRequired": false, + "description": [], "signature": [ { "pluginId": "embeddable", @@ -5767,24 +6395,25 @@ }, "> | undefined" ], - "description": [], "source": { "path": "src/plugins/embeddable/public/lib/embeddables/embeddable_factory.ts", "lineNumber": 113 - } + }, + "deprecated": false, + "isRequired": false } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/embeddable/public/lib/embeddables/embeddable_factory.ts", - "lineNumber": 110 - } + "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?: ", { @@ -5820,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": 123 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "embeddable", "id": "def-public.EmbeddableFactory.create.$2", "type": "Object", + "tags": [], "label": "parent", - "isRequired": false, + "description": [], "signature": [ { "pluginId": "embeddable", @@ -5869,239 +6505,260 @@ }, "> | undefined" ], - "description": [], "source": { "path": "src/plugins/embeddable/public/lib/embeddables/embeddable_factory.ts", "lineNumber": 124 - } + }, + "deprecated": false, + "isRequired": false } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/embeddable/public/lib/embeddables/embeddable_factory.ts", - "lineNumber": 122 - } + "returnComment": [] } ], - "source": { - "path": "src/plugins/embeddable/public/lib/embeddables/embeddable_factory.ts", - "lineNumber": 31 - }, "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": 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": 21 }, - "signature": [ - "string | undefined" - ] + "deprecated": false } ], - "source": { - "path": "src/plugins/embeddable/public/lib/embeddables/embeddable_factory.ts", - "lineNumber": 19 - }, "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", "<", @@ -6123,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<", { @@ -6173,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<", { @@ -6219,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", @@ -6239,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", @@ -6270,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", @@ -6313,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", @@ -6689,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?" @@ -6703,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", @@ -6742,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." @@ -6755,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." @@ -6768,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 ", { @@ -6849,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": [ "() => ", { @@ -7033,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": [ "() => ", { @@ -7110,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": 25 }, - "signature": [ - "any" - ] + "deprecated": false } ], - "source": { - "path": "src/plugins/embeddable/public/lib/embeddables/embeddable_factory.ts", - "lineNumber": 24 - }, "initialIsOpen": false }, { + "parentPluginId": "embeddable", "id": "def-public.PanelState", "type": "Interface", + "tags": [], "label": "PanelState", + "description": [], "signature": [ { "pluginId": "embeddable", @@ -7210,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", @@ -7331,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: ", { @@ -7368,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", @@ -7391,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", @@ -7474,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", @@ -7509,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<", { @@ -7546,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": [], + "signature": [ + "\"ACTION_ADD_PANEL\"" + ], "source": { "path": "src/plugins/embeddable/public/lib/panel/panel_header/panel_actions/add_panel/add_panel_action.ts", "lineNumber": 17 }, - "signature": [ - "\"ACTION_ADD_PANEL\"" - ], + "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", @@ -7653,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\" | \"grouping\" | \"getIconType\" | \"getDescription\">>" - ], + "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: ", { @@ -7737,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", @@ -8104,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<", { @@ -8211,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: ", { @@ -8249,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?: ", { @@ -8278,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 } @@ -8341,9 +9217,12 @@ "functions": [], "interfaces": [ { + "parentPluginId": "embeddable", "id": "def-server.EmbeddableRegistryDefinition", "type": "Interface", + "tags": [], "label": "EmbeddableRegistryDefinition", + "description": [], "signature": [ { "pluginId": "embeddable", @@ -8362,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", @@ -8405,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 } ], @@ -8431,9 +9315,12 @@ "misc": [], "objects": [], "setup": { + "parentPluginId": "embeddable", "id": "def-server.EmbeddableSetup", "type": "Interface", + "tags": [], "label": "EmbeddableSetup", + "description": [], "signature": [ { "pluginId": "embeddable", @@ -8460,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: ", { @@ -8491,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: ", { @@ -8521,29 +9410,32 @@ "text": "SerializableState" }, ">) => void" - ] + ], + "source": { + "path": "src/plugins/embeddable/server/plugin.ts", + "lineNumber": 29 + }, + "deprecated": false } ], - "source": { - "path": "src/plugins/embeddable/server/plugin.ts", - "lineNumber": 27 - }, "lifecycle": "setup", "initialIsOpen": true }, "start": { + "parentPluginId": "embeddable", "id": "def-server.EmbeddableStart", "type": "Type", - "label": "EmbeddableStart", "tags": [], + "label": "EmbeddableStart", "description": [], + "signature": [ + "PersistableStateService" + ], "source": { "path": "src/plugins/embeddable/server/plugin.ts", "lineNumber": 32 }, - "signature": [ - "PersistableStateService" - ], + "deprecated": false, "lifecycle": "start", "initialIsOpen": true } @@ -8552,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: ", { @@ -8597,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: ", { @@ -8661,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", @@ -8689,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: ", { @@ -8724,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", @@ -8752,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: ", { @@ -8785,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", @@ -8813,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", @@ -8867,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: ", { @@ -8942,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", @@ -8966,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", @@ -8999,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", @@ -9099,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", @@ -9155,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_enhanced.json b/api_docs/embeddable_enhanced.json index 42462bbec32a3..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": 35 - }, "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": 36 - }, "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": 34 - }, "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": 40 - }, "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": 41 - }, "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": 39 - }, "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": 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": 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 cc3df6cbd9f8b..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": 25 - } - } + "tags": [ + "throws" + ], + "label": "handleEsError", + "description": [ + "\nFor errors returned by the new elasticsearch js client.\n" ], "signature": [ "({ error, response, handleCustomError, }: EsErrorHandlerParams) => ", @@ -1297,81 +1450,104 @@ }, "" ], - "description": [ - "\nFor errors returned by the new elasticsearch js client.\n" - ], - "label": "handleEsError", "source": { "path": "src/plugins/es_ui_shared/__packages_do_not_import__/errors/handle_es_error.ts", "lineNumber": 25 }, - "tags": [ - "throws" + "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 } @@ -1386,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", @@ -1449,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 feb6d56c28439..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": 94 - }, "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": 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": 113 - }, "signature": [ { "pluginId": "expressions", @@ -105,20 +112,22 @@ "" - ] + ], + "source": { + "path": "src/plugins/expressions/common/execution/execution.ts", + "lineNumber": 113 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-public.Execution.result", "type": "Object", + "tags": [], "label": "result", "description": [ "\nFuture that tracks result or error of this execution." ], - "source": { - "path": "src/plugins/expressions/common/execution/execution.ts", - "lineNumber": 140 - }, "signature": [ "Observable", ">" - ] + ], + "source": { + "path": "src/plugins/expressions/common/execution/execution.ts", + "lineNumber": 140 + }, + "deprecated": false }, { - "tags": [], + "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." ], - "source": { - "path": "src/plugins/expressions/common/execution/execution.ts", - "lineNumber": 153 - }, "signature": [ { "pluginId": "expressions", @@ -169,47 +180,65 @@ "text": "ExecutionContract" }, "" - ] + ], + "source": { + "path": "src/plugins/expressions/common/execution/execution.ts", + "lineNumber": 153 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-public.Execution.expression", "type": "string", + "tags": [], "label": "expression", "description": [], "source": { "path": "src/plugins/expressions/common/execution/execution.ts", "lineNumber": 159 - } + }, + "deprecated": false }, { + "parentPluginId": "expressions", "id": "def-public.Execution.inspectorAdapters", "type": "Uncategorized", - "label": "inspectorAdapters", "tags": [], + "label": "inspectorAdapters", "description": [], + "signature": [ + "InspectorAdapters" + ], "source": { "path": "src/plugins/expressions/common/execution/execution.ts", "lineNumber": 161 }, - "signature": [ - "InspectorAdapters" - ] + "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", @@ -219,42 +248,45 @@ "text": "ExecutionParams" } ], - "description": [], "source": { "path": "src/plugins/expressions/common/execution/execution.ts", "lineNumber": 165 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/expressions/common/execution/execution.ts", - "lineNumber": 165 - } + "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": 229 - } + }, + "deprecated": false, + "children": [], + "returnComment": [] }, { + "parentPluginId": "expressions", "id": "def-public.Execution.start", "type": "Function", + "tags": [], "label": "start", + "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", @@ -284,36 +316,39 @@ }, " | undefined; }>>" ], - "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." - ], + "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": 239 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/expressions/common/execution/execution.ts", - "lineNumber": 239 - } + "returnComment": [] }, { + "parentPluginId": "expressions", "id": "def-public.Execution.invokeChain", "type": "Function", + "tags": [], "label": "invokeChain", + "description": [], "signature": [ "(chainArr: ", { @@ -327,13 +362,19 @@ "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", @@ -344,38 +385,40 @@ }, "[]" ], - "description": [], "source": { "path": "src/plugins/expressions/common/execution/execution.ts", "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": 263 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/expressions/common/execution/execution.ts", - "lineNumber": 263 - } + "returnComment": [] }, { + "parentPluginId": "expressions", "id": "def-public.Execution.invokeFunction", "type": "Function", + "tags": [], "label": "invokeFunction", + "description": [], "signature": [ "(fn: ", { @@ -389,13 +432,19 @@ "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", @@ -405,97 +454,110 @@ "text": "ExpressionFunction" } ], - "description": [], "source": { "path": "src/plugins/expressions/common/execution/execution.ts", "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": 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": 339 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/expressions/common/execution/execution.ts", - "lineNumber": 336 - } + "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": 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": 374 - } + }, + "deprecated": false, + "isRequired": false } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/expressions/common/execution/execution.ts", - "lineNumber": 374 - } + "returnComment": [] }, { + "parentPluginId": "expressions", "id": "def-public.Execution.resolveArgs", "type": "Function", + "tags": [], "label": "resolveArgs", + "description": [], "signature": [ "(fnDef: ", { @@ -509,13 +571,19 @@ "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", @@ -525,52 +593,57 @@ "text": "ExpressionFunction" } ], - "description": [], "source": { "path": "src/plugins/expressions/common/execution/execution.ts", "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": 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": 400 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/expressions/common/execution/execution.ts", - "lineNumber": 400 - } + "returnComment": [] }, { + "parentPluginId": "expressions", "id": "def-public.Execution.interpret", "type": "Function", + "tags": [], "label": "interpret", + "description": [], "signature": [ "(ast: ", { @@ -584,13 +657,19 @@ "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", @@ -600,42 +679,38 @@ "text": "ExpressionAstNode" } ], - "description": [], "source": { "path": "src/plugins/expressions/common/execution/execution.ts", "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": 489 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/expressions/common/execution/execution.ts", - "lineNumber": 489 - } + "returnComment": [] } ], - "source": { - "path": "src/plugins/expressions/common/execution/execution.ts", - "lineNumber": 84 - }, "initialIsOpen": false }, { + "parentPluginId": "expressions", "id": "def-public.ExecutionContract", "type": "Class", "tags": [], @@ -653,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": 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", @@ -689,42 +780,45 @@ }, "" ], - "description": [], "source": { "path": "src/plugins/expressions/common/execution/execution_contract.ts", "lineNumber": 26 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/expressions/common/execution/execution_contract.ts", - "lineNumber": 26 - } + "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": 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<", { @@ -752,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": 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": 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": [ "() => ", { @@ -795,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": 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": 78 }, - "tags": [], + "deprecated": false, + "children": [], "returnComment": [] } ], - "source": { - "path": "src/plugins/expressions/common/execution/execution_contract.ts", - "lineNumber": 19 - }, "initialIsOpen": false }, { + "parentPluginId": "expressions", "id": "def-public.Executor", "type": "Class", "tags": [], @@ -863,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 ", { @@ -879,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", @@ -896,30 +1004,23 @@ }, " | undefined" ], - "description": [], "source": { "path": "src/plugins/expressions/common/executor/executor.ts", "lineNumber": 84 - } + }, + "deprecated": false, + "isRequired": false } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 83 - } + "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": 92 - }, "signature": [ { "pluginId": "expressions", @@ -929,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": 97 - }, "signature": [ { "pluginId": "expressions", @@ -951,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": 102 - }, "signature": [ { "pluginId": "expressions", @@ -973,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", @@ -999,24 +1120,23 @@ }, " | undefined" ], - "description": [], "source": { "path": "src/plugins/expressions/common/executor/executor.ts", "lineNumber": 104 - } + }, + "deprecated": false, + "isRequired": false } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 104 - } + "returnComment": [] }, { + "parentPluginId": "expressions", "id": "def-public.Executor.registerFunction", "type": "Function", + "tags": [], "label": "registerFunction", + "description": [], "signature": [ "(functionDefinition: ", { @@ -1036,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", @@ -1061,24 +1187,23 @@ }, ")" ], - "description": [], "source": { "path": "src/plugins/expressions/common/executor/executor.ts", "lineNumber": 111 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 110 - } + "returnComment": [] }, { + "parentPluginId": "expressions", "id": "def-public.Executor.getFunction", "type": "Function", + "tags": [], "label": "getFunction", + "description": [], "signature": [ "(name: string) => ", { @@ -1090,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": 119 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 119 - } + "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": 123 - } + }, + "deprecated": false, + "children": [], + "returnComment": [] }, { + "parentPluginId": "expressions", "id": "def-public.Executor.registerType", "type": "Function", + "tags": [], "label": "registerType", + "description": [], "signature": [ "(typeDefinition: ", { @@ -1161,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", @@ -1186,24 +1324,23 @@ }, ")" ], - "description": [], "source": { "path": "src/plugins/expressions/common/executor/executor.ts", "lineNumber": 128 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 127 - } + "returnComment": [] }, { + "parentPluginId": "expressions", "id": "def-public.Executor.getType", "type": "Function", + "tags": [], "label": "getType", + "description": [], "signature": [ "(name: string) => ", { @@ -1215,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": 136 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 136 - } + "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": 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": 144 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 144 - } + "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": 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 | ", { @@ -1348,15 +1501,21 @@ "text": "ErrorLike" } ], - "description": [ - "\nExecute expression and return result.\n" - ], + "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 | ", { @@ -1367,35 +1526,39 @@ "text": "ExpressionAstExpression" } ], - "description": [ - "Expression AST or a string representing expression." - ], "source": { "path": "src/plugins/expressions/common/executor/executor.ts", "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": 162 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "expressions", "id": "def-public.Executor.run.$3", "type": "Object", + "tags": [], "label": "params", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "expressions", @@ -1405,24 +1568,23 @@ "text": "ExpressionExecutionParams" } ], - "description": [], "source": { "path": "src/plugins/expressions/common/executor/executor.ts", "lineNumber": 163 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 160 - } + "returnComment": [] }, { + "parentPluginId": "expressions", "id": "def-public.Executor.createExecution", "type": "Function", + "tags": [], "label": "createExecution", + "description": [], "signature": [ "(ast: string | ", { @@ -1458,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 | ", { @@ -1475,17 +1643,20 @@ "text": "ExpressionAstExpression" } ], - "description": [], "source": { "path": "src/plugins/expressions/common/executor/executor.ts", "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", @@ -1495,24 +1666,23 @@ "text": "ExpressionExecutionParams" } ], - "description": [], "source": { "path": "src/plugins/expressions/common/executor/executor.ts", "lineNumber": 170 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 168 - } + "returnComment": [] }, { + "parentPluginId": "expressions", "id": "def-public.Executor.inject", "type": "Function", + "tags": [], "label": "inject", + "description": [], "signature": [ "(ast: ", { @@ -1533,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", @@ -1549,39 +1725,41 @@ "text": "ExpressionAstExpression" } ], - "description": [], "source": { "path": "src/plugins/expressions/common/executor/executor.ts", "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": 216 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 216 - } + "returnComment": [] }, { + "parentPluginId": "expressions", "id": "def-public.Executor.extract", "type": "Function", + "tags": [], "label": "extract", + "description": [], "signature": [ "(ast: ", { @@ -1603,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", @@ -1619,24 +1803,23 @@ "text": "ExpressionAstExpression" } ], - "description": [], "source": { "path": "src/plugins/expressions/common/executor/executor.ts", "lineNumber": 229 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 229 - } + "returnComment": [] }, { + "parentPluginId": "expressions", "id": "def-public.Executor.telemetry", "type": "Function", + "tags": [], "label": "telemetry", + "description": [], "signature": [ "(ast: ", { @@ -1648,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", @@ -1664,38 +1853,40 @@ "text": "ExpressionAstExpression" } ], - "description": [], "source": { "path": "src/plugins/expressions/common/executor/executor.ts", "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": 240 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 240 - } + "returnComment": [] }, { + "parentPluginId": "expressions", "id": "def-public.Executor.migrate", "type": "Function", + "tags": [], "label": "migrate", + "description": [], "signature": [ "(ast: ", { @@ -1714,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", @@ -1730,38 +1927,40 @@ "text": "SerializableState" } ], - "description": [], "source": { "path": "src/plugins/expressions/common/executor/executor.ts", "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": 248 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 248 - } + "returnComment": [] }, { + "parentPluginId": "expressions", "id": "def-public.Executor.fork", "type": "Function", + "tags": [], "label": "fork", + "description": [], "signature": [ "() => ", { @@ -1773,23 +1972,19 @@ }, "" ], - "description": [], - "children": [], - "tags": [], - "returnComment": [], "source": { "path": "src/plugins/expressions/common/executor/executor.ts", "lineNumber": 257 - } + }, + "deprecated": false, + "children": [], + "returnComment": [] } ], - "source": { - "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 81 - }, "initialIsOpen": false }, { + "parentPluginId": "expressions", "id": "def-public.ExpressionFunction", "type": "Class", "tags": [], @@ -1821,11 +2016,17 @@ }, "[]>>" ], + "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" @@ -1833,28 +2034,32 @@ "source": { "path": "src/plugins/expressions/common/expression_functions/expression_function.ts", "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": 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." @@ -1862,28 +2067,32 @@ "source": { "path": "src/plugins/expressions/common/expression_functions/expression_function.ts", "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": 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." @@ -1891,59 +2100,63 @@ "source": { "path": "src/plugins/expressions/common/expression_functions/expression_function.ts", "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": 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": 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": 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": 56 - }, "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": 60 - }, "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": 63 - }, "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": 67 - }, "signature": [ "{ [key: string]: (state: ", { @@ -2048,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", @@ -2073,204 +2306,237 @@ "text": "AnyExpressionFunctionDefinition" } ], - "description": [], "source": { "path": "src/plugins/expressions/common/expression_functions/expression_function.ts", "lineNumber": 71 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/expressions/common/expression_functions/expression_function.ts", - "lineNumber": 71 - } + "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": 105 - } + }, + "deprecated": false, + "isRequired": true } ], - "signature": [ - "(type: string) => boolean" - ], - "description": [], - "label": "accepts", - "source": { - "path": "src/plugins/expressions/common/expression_functions/expression_function.ts", - "lineNumber": 105 - }, - "tags": [], "returnComment": [] } ], - "source": { - "path": "src/plugins/expressions/common/expression_functions/expression_function.ts", - "lineNumber": 17 - }, "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", @@ -2281,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": [], @@ -2349,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: ", { @@ -2428,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", @@ -2454,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": [], @@ -2507,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: ", { @@ -2531,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", @@ -2556,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) => ", { @@ -2585,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": [ "() => ", { @@ -2648,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", "<", @@ -2722,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", @@ -2864,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": [], @@ -2915,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": [], @@ -3008,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", @@ -3033,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: ", { @@ -3070,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", @@ -3087,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: ", { @@ -3123,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", @@ -3139,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": [], @@ -3216,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", @@ -3241,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: ", { @@ -3278,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", @@ -3295,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: ", { @@ -3331,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", @@ -3347,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": [], @@ -3418,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": 176 - }, "signature": [ { "pluginId": "expressions", @@ -3438,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": 177 - }, "signature": [ { "pluginId": "expressions", @@ -3458,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", @@ -3483,29 +3880,57 @@ "text": "ExpressionServiceParams" } ], - "description": [], "source": { "path": "src/plugins/expressions/common/service/expressions_services.ts", "lineNumber": 179 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/expressions/common/service/expressions_services.ts", - "lineNumber": 179 - } + "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", @@ -3524,52 +3949,55 @@ }, ")" ], - "description": [], "source": { "path": "src/plugins/expressions/common/service/expressions_services.ts", "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": 219 + "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", @@ -3588,50 +4016,55 @@ }, ")" ], - "description": [], "source": { "path": "src/plugins/expressions/common/service/expressions_services.ts", "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": 223 + "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", @@ -3650,50 +4083,55 @@ }, ")" ], - "description": [], "source": { "path": "src/plugins/expressions/common/service/expressions_services.ts", "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": 227 + "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 | ", { @@ -3704,31 +4142,37 @@ "text": "ExpressionAstExpression" } ], - "description": [], "source": { "path": "src/plugins/expressions/common/service/expressions_services.ts", "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": 231 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "expressions", "id": "def-public.ExpressionsService.run.$3", "type": "Object", + "tags": [], "label": "params", - "isRequired": false, + "description": [], "signature": [ { "pluginId": "expressions", @@ -3739,84 +4183,69 @@ }, " | undefined" ], - "description": [], "source": { "path": "src/plugins/expressions/common/service/expressions_services.ts", "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": 231 + "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": 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": 234 - }, - "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": 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": 244 - } - } - ], + "tags": [], + "label": "getRenderer", + "description": [], "signature": [ "(name: string) => ", { @@ -3869,19 +4283,41 @@ }, " | null" ], - "description": [], - "label": "getRenderer", "source": { "path": "src/plugins/expressions/common/service/expressions_services.ts", "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": 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": 254 - } - } - ], + "tags": [], + "label": "getType", + "description": [], "signature": [ "(name: string) => ", { @@ -3934,19 +4355,41 @@ }, " | undefined" ], - "description": [], - "label": "getType", "source": { "path": "src/plugins/expressions/common/service/expressions_services.ts", "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": 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": 263 - }, "signature": [ "(ast: string | ", { @@ -4005,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": [ "() => ", { @@ -4021,24 +4466,47 @@ "text": "ExpressionsService" } ], - "description": [], - "label": "fork", "source": { "path": "src/plugins/expressions/common/service/expressions_services.ts", "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", @@ -4048,27 +4516,42 @@ "text": "ExpressionAstExpression" } ], - "description": [], "source": { "path": "src/plugins/expressions/common/service/expressions_services.ts", "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": 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: ", { @@ -4078,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": 281 + "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", @@ -4109,13 +4595,27 @@ "text": "ExpressionAstExpression" } ], - "description": [], "source": { "path": "src/plugins/expressions/common/service/expressions_services.ts", "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: ", { @@ -4125,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": 293 + "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", @@ -4168,40 +4658,55 @@ "text": "ExpressionAstExpression" } ], - "description": [], "source": { "path": "src/plugins/expressions/common/service/expressions_services.ts", "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": 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", @@ -4210,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": 303 + "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", @@ -4241,62 +4737,44 @@ "text": "SerializableState" } ], - "description": [], "source": { "path": "src/plugins/expressions/common/service/expressions_services.ts", "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": 313 - } - } - ], - "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" + }, + "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": 313 - }, - "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<", { @@ -4308,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": 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": [ "() => ", { @@ -4333,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": 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": 333 - } + }, + "deprecated": false, + "children": [], + "returnComment": [] } ], - "source": { - "path": "src/plugins/expressions/common/service/expressions_services.ts", - "lineNumber": 175 - }, "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." @@ -4396,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", @@ -4481,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) => ", { @@ -4525,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) => ", { @@ -4564,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": [], @@ -4810,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", @@ -4835,24 +5383,23 @@ }, "" ], - "description": [], "source": { "path": "src/plugins/expressions/common/executor/executor.ts", "lineNumber": 60 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 60 - } + "returnComment": [] }, { + "parentPluginId": "expressions", "id": "def-public.FunctionsRegistry.register", "type": "Function", + "tags": [], "label": "register", + "description": [], "signature": [ "(functionDefinition: ", { @@ -4872,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", @@ -4897,24 +5450,23 @@ }, ")" ], - "description": [], "source": { "path": "src/plugins/expressions/common/executor/executor.ts", "lineNumber": 63 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 62 - } + "returnComment": [] }, { + "parentPluginId": "expressions", "id": "def-public.FunctionsRegistry.get", "type": "Function", + "tags": [], "label": "get", + "description": [], "signature": [ "(id: string) => ", { @@ -4926,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": 68 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 68 - } + "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": 72 - } + }, + "deprecated": false, + "children": [], + "returnComment": [] }, { + "parentPluginId": "expressions", "id": "def-public.FunctionsRegistry.toArray", "type": "Function", + "tags": [], "label": "toArray", + "description": [], "signature": [ "() => ", { @@ -4989,23 +5548,19 @@ }, "[]" ], - "description": [], - "children": [], - "tags": [], - "returnComment": [], "source": { "path": "src/plugins/expressions/common/executor/executor.ts", "lineNumber": 76 - } + }, + "deprecated": false, + "children": [], + "returnComment": [] } ], - "source": { - "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 59 - }, "initialIsOpen": false }, { + "parentPluginId": "expressions", "id": "def-public.TablesAdapter", "type": "Class", "tags": [], @@ -5022,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: ", { @@ -5038,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", @@ -5068,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]: ", { @@ -5102,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": [], @@ -5143,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", @@ -5168,24 +5749,23 @@ }, "" ], - "description": [], "source": { "path": "src/plugins/expressions/common/executor/executor.ts", "lineNumber": 38 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 38 - } + "returnComment": [] }, { + "parentPluginId": "expressions", "id": "def-public.TypesRegistry.register", "type": "Function", + "tags": [], "label": "register", + "description": [], "signature": [ "(typeDefinition: ", { @@ -5205,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", @@ -5230,24 +5816,23 @@ }, ")" ], - "description": [], "source": { "path": "src/plugins/expressions/common/executor/executor.ts", "lineNumber": 41 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 40 - } + "returnComment": [] }, { + "parentPluginId": "expressions", "id": "def-public.TypesRegistry.get", "type": "Function", + "tags": [], "label": "get", + "description": [], "signature": [ "(id: string) => ", { @@ -5259,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": 46 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 46 - } + "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": 50 - } + }, + "deprecated": false, + "children": [], + "returnComment": [] }, { + "parentPluginId": "expressions", "id": "def-public.TypesRegistry.toArray", "type": "Function", + "tags": [], "label": "toArray", + "description": [], "signature": [ "() => ", { @@ -5322,28 +5914,30 @@ }, "[]" ], - "description": [], - "children": [], - "tags": [], - "returnComment": [], "source": { "path": "src/plugins/expressions/common/executor/executor.ts", "lineNumber": 54 - } + }, + "deprecated": false, + "children": [], + "returnComment": [] } ], - "source": { - "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 37 - }, "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 | ", { @@ -5378,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 | ", { @@ -5414,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: ", { @@ -5474,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", @@ -5493,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] | ", { @@ -5525,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 ", { @@ -5561,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 ", { @@ -5593,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: ", { @@ -5623,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", @@ -5641,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\" ? ", { @@ -5720,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) => ", { @@ -5773,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", @@ -5820,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", @@ -5892,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", @@ -5964,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", @@ -5987,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": [ "(() => ", { @@ -6118,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": 72 - }, "signature": [ { "pluginId": "expressions", @@ -6169,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": 73 - }, "signature": [ { "pluginId": "expressions", @@ -6190,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": 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": 75 - }, "signature": [ { "pluginId": "expressions", @@ -6224,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": 71 - }, "initialIsOpen": false }, { + "parentPluginId": "expressions", "id": "def-public.ExecutionState", "type": "Interface", + "tags": [], "label": "ExecutionState", + "description": [], "signature": [ { "pluginId": "expressions", @@ -6255,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", @@ -6276,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", @@ -6347,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", @@ -6467,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": [ "() => ", { @@ -6542,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", @@ -6583,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", @@ -6623,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: ", { @@ -6665,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) => (", { @@ -6691,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: (", { @@ -6717,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": [ "() => ", { @@ -6760,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", @@ -6847,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\" | ", { @@ -6908,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", @@ -6931,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]: ", { @@ -6955,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." @@ -6984,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", @@ -7105,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", @@ -7125,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", @@ -7145,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", @@ -7165,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", @@ -7185,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", @@ -7205,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", @@ -7225,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", @@ -7245,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", @@ -7318,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." @@ -7332,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." @@ -7393,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: ", { @@ -7417,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", @@ -7479,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": 79 - }, "signature": [ "(name: string) => ", { @@ -7548,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": 87 - }, "signature": [ "(name: string) => ", { @@ -7572,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": 95 - }, "signature": [ "(name: string) => ", { @@ -7596,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": 121 - }, "signature": [ "(ast: string | ", { @@ -7628,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": 132 - }, "signature": [ "(ast: string | ", { @@ -7668,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": 148 - }, "signature": [ "() => ", { @@ -7691,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": 72 - }, "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", @@ -7714,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]: ", { @@ -7795,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]: ", { @@ -7817,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", @@ -7881,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", @@ -8084,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: ", { @@ -8163,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": [ "() => ", { @@ -8284,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", @@ -8337,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", @@ -8550,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 | ", { @@ -8600,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?: ", { @@ -8622,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: ", { @@ -8658,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", @@ -8733,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", @@ -8771,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": 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": 57 }, - "signature": [ - "TParams | undefined" - ] + "deprecated": false } ], - "source": { - "path": "src/plugins/expressions/common/types/common.ts", - "lineNumber": 55 - }, "initialIsOpen": false } ], "enums": [ { + "parentPluginId": "expressions", "id": "def-public.FontStyle", "type": "Enum", - "label": "FontStyle", "tags": [], + "label": "FontStyle", "description": [ "\nEnum of supported CSS `font-style` properties." ], @@ -8825,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." ], @@ -8839,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." ], @@ -8853,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." ], @@ -8867,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." ], @@ -8881,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<", { @@ -8910,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\" | \"unknown\" | \"_source\" | \"attachment\" | \"geo_point\" | \"geo_shape\" | \"murmur3\" | \"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 | ", { @@ -9028,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": [], + "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-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 | ", { @@ -9088,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<", { @@ -9111,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<", { @@ -9387,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<", { @@ -9433,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": [ - "(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" - ], + "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\" | ", { @@ -9490,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" ], + "signature": [ + "\"date\" | \"filter\"" + ], "source": { "path": "src/plugins/expressions/common/types/common.ts", "lineNumber": 48 }, - "signature": [ - "\"date\" | \"filter\"" - ], + "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) => ", { @@ -9565,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", @@ -9589,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 ", { @@ -9628,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 }: ", { @@ -9664,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 } @@ -9693,6 +10825,7 @@ "server": { "classes": [ { + "parentPluginId": "expressions", "id": "def-server.Execution", "type": "Class", "tags": [], @@ -9708,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": 94 - }, "signature": [ { "pluginId": "expressions", @@ -9754,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": 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": 113 - }, "signature": [ { "pluginId": "expressions", @@ -9795,20 +10934,22 @@ "" - ] + ], + "source": { + "path": "src/plugins/expressions/common/execution/execution.ts", + "lineNumber": 113 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-server.Execution.result", "type": "Object", + "tags": [], "label": "result", "description": [ "\nFuture that tracks result or error of this execution." ], - "source": { - "path": "src/plugins/expressions/common/execution/execution.ts", - "lineNumber": 140 - }, "signature": [ "Observable", ">" - ] + ], + "source": { + "path": "src/plugins/expressions/common/execution/execution.ts", + "lineNumber": 140 + }, + "deprecated": false }, { - "tags": [], + "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." ], - "source": { - "path": "src/plugins/expressions/common/execution/execution.ts", - "lineNumber": 153 - }, "signature": [ { "pluginId": "expressions", @@ -9859,47 +11002,65 @@ "text": "ExecutionContract" }, "" - ] + ], + "source": { + "path": "src/plugins/expressions/common/execution/execution.ts", + "lineNumber": 153 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-server.Execution.expression", "type": "string", + "tags": [], "label": "expression", "description": [], "source": { "path": "src/plugins/expressions/common/execution/execution.ts", "lineNumber": 159 - } + }, + "deprecated": false }, { + "parentPluginId": "expressions", "id": "def-server.Execution.inspectorAdapters", "type": "Uncategorized", - "label": "inspectorAdapters", "tags": [], + "label": "inspectorAdapters", "description": [], + "signature": [ + "InspectorAdapters" + ], "source": { "path": "src/plugins/expressions/common/execution/execution.ts", "lineNumber": 161 }, - "signature": [ - "InspectorAdapters" - ] + "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", @@ -9909,42 +11070,45 @@ "text": "ExecutionParams" } ], - "description": [], "source": { "path": "src/plugins/expressions/common/execution/execution.ts", "lineNumber": 165 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/expressions/common/execution/execution.ts", - "lineNumber": 165 - } + "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": 229 - } + }, + "deprecated": false, + "children": [], + "returnComment": [] }, { + "parentPluginId": "expressions", "id": "def-server.Execution.start", "type": "Function", + "tags": [], "label": "start", + "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", @@ -9974,36 +11138,39 @@ }, " | undefined; }>>" ], - "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." - ], + "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": 239 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/expressions/common/execution/execution.ts", - "lineNumber": 239 - } + "returnComment": [] }, { + "parentPluginId": "expressions", "id": "def-server.Execution.invokeChain", "type": "Function", + "tags": [], "label": "invokeChain", + "description": [], "signature": [ "(chainArr: ", { @@ -10017,13 +11184,19 @@ "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", @@ -10034,38 +11207,40 @@ }, "[]" ], - "description": [], "source": { "path": "src/plugins/expressions/common/execution/execution.ts", "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": 263 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/expressions/common/execution/execution.ts", - "lineNumber": 263 - } + "returnComment": [] }, { + "parentPluginId": "expressions", "id": "def-server.Execution.invokeFunction", "type": "Function", + "tags": [], "label": "invokeFunction", + "description": [], "signature": [ "(fn: ", { @@ -10079,13 +11254,19 @@ "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", @@ -10095,97 +11276,110 @@ "text": "ExpressionFunction" } ], - "description": [], "source": { "path": "src/plugins/expressions/common/execution/execution.ts", "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": 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": 339 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/expressions/common/execution/execution.ts", - "lineNumber": 336 - } + "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": 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": 374 - } + }, + "deprecated": false, + "isRequired": false } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/expressions/common/execution/execution.ts", - "lineNumber": 374 - } + "returnComment": [] }, { + "parentPluginId": "expressions", "id": "def-server.Execution.resolveArgs", "type": "Function", + "tags": [], "label": "resolveArgs", + "description": [], "signature": [ "(fnDef: ", { @@ -10199,13 +11393,19 @@ "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", @@ -10215,52 +11415,57 @@ "text": "ExpressionFunction" } ], - "description": [], "source": { "path": "src/plugins/expressions/common/execution/execution.ts", "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": 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": 400 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/expressions/common/execution/execution.ts", - "lineNumber": 400 - } + "returnComment": [] }, { + "parentPluginId": "expressions", "id": "def-server.Execution.interpret", "type": "Function", + "tags": [], "label": "interpret", + "description": [], "signature": [ "(ast: ", { @@ -10274,13 +11479,19 @@ "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", @@ -10290,42 +11501,38 @@ "text": "ExpressionAstNode" } ], - "description": [], "source": { "path": "src/plugins/expressions/common/execution/execution.ts", "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": 489 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/expressions/common/execution/execution.ts", - "lineNumber": 489 - } + "returnComment": [] } ], - "source": { - "path": "src/plugins/expressions/common/execution/execution.ts", - "lineNumber": 84 - }, "initialIsOpen": false }, { + "parentPluginId": "expressions", "id": "def-server.Executor", "type": "Class", "tags": [], @@ -10357,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 ", { @@ -10373,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", @@ -10390,30 +11611,23 @@ }, " | undefined" ], - "description": [], "source": { "path": "src/plugins/expressions/common/executor/executor.ts", "lineNumber": 84 - } + }, + "deprecated": false, + "isRequired": false } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 83 - } + "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": 92 - }, "signature": [ { "pluginId": "expressions", @@ -10423,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": 97 - }, "signature": [ { "pluginId": "expressions", @@ -10445,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": 102 - }, "signature": [ { "pluginId": "expressions", @@ -10467,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", @@ -10493,24 +11727,23 @@ }, " | undefined" ], - "description": [], "source": { "path": "src/plugins/expressions/common/executor/executor.ts", "lineNumber": 104 - } + }, + "deprecated": false, + "isRequired": false } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 104 - } + "returnComment": [] }, { + "parentPluginId": "expressions", "id": "def-server.Executor.registerFunction", "type": "Function", + "tags": [], "label": "registerFunction", + "description": [], "signature": [ "(functionDefinition: ", { @@ -10530,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", @@ -10555,24 +11794,23 @@ }, ")" ], - "description": [], "source": { "path": "src/plugins/expressions/common/executor/executor.ts", "lineNumber": 111 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 110 - } + "returnComment": [] }, { + "parentPluginId": "expressions", "id": "def-server.Executor.getFunction", "type": "Function", + "tags": [], "label": "getFunction", + "description": [], "signature": [ "(name: string) => ", { @@ -10584,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": 119 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 119 - } + "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": 123 - } + }, + "deprecated": false, + "children": [], + "returnComment": [] }, { + "parentPluginId": "expressions", "id": "def-server.Executor.registerType", "type": "Function", + "tags": [], "label": "registerType", + "description": [], "signature": [ "(typeDefinition: ", { @@ -10655,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", @@ -10680,24 +11931,23 @@ }, ")" ], - "description": [], "source": { "path": "src/plugins/expressions/common/executor/executor.ts", "lineNumber": 128 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 127 - } + "returnComment": [] }, { + "parentPluginId": "expressions", "id": "def-server.Executor.getType", "type": "Function", + "tags": [], "label": "getType", + "description": [], "signature": [ "(name: string) => ", { @@ -10709,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": 136 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 136 - } + "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": 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": 144 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 144 - } + "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": 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 | ", { @@ -10842,15 +12108,21 @@ "text": "ErrorLike" } ], - "description": [ - "\nExecute expression and return result.\n" - ], + "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 | ", { @@ -10861,35 +12133,39 @@ "text": "ExpressionAstExpression" } ], - "description": [ - "Expression AST or a string representing expression." - ], "source": { "path": "src/plugins/expressions/common/executor/executor.ts", "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": 162 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "expressions", "id": "def-server.Executor.run.$3", "type": "Object", + "tags": [], "label": "params", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "expressions", @@ -10899,24 +12175,23 @@ "text": "ExpressionExecutionParams" } ], - "description": [], "source": { "path": "src/plugins/expressions/common/executor/executor.ts", "lineNumber": 163 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 160 - } + "returnComment": [] }, { + "parentPluginId": "expressions", "id": "def-server.Executor.createExecution", "type": "Function", + "tags": [], "label": "createExecution", + "description": [], "signature": [ "(ast: string | ", { @@ -10952,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 | ", { @@ -10969,17 +12250,20 @@ "text": "ExpressionAstExpression" } ], - "description": [], "source": { "path": "src/plugins/expressions/common/executor/executor.ts", "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", @@ -10989,24 +12273,23 @@ "text": "ExpressionExecutionParams" } ], - "description": [], "source": { "path": "src/plugins/expressions/common/executor/executor.ts", "lineNumber": 170 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 168 - } + "returnComment": [] }, { + "parentPluginId": "expressions", "id": "def-server.Executor.inject", "type": "Function", + "tags": [], "label": "inject", + "description": [], "signature": [ "(ast: ", { @@ -11027,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", @@ -11043,39 +12332,41 @@ "text": "ExpressionAstExpression" } ], - "description": [], "source": { "path": "src/plugins/expressions/common/executor/executor.ts", "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": 216 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 216 - } + "returnComment": [] }, { + "parentPluginId": "expressions", "id": "def-server.Executor.extract", "type": "Function", + "tags": [], "label": "extract", + "description": [], "signature": [ "(ast: ", { @@ -11097,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", @@ -11113,24 +12410,23 @@ "text": "ExpressionAstExpression" } ], - "description": [], "source": { "path": "src/plugins/expressions/common/executor/executor.ts", "lineNumber": 229 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 229 - } + "returnComment": [] }, { + "parentPluginId": "expressions", "id": "def-server.Executor.telemetry", "type": "Function", + "tags": [], "label": "telemetry", + "description": [], "signature": [ "(ast: ", { @@ -11142,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", @@ -11158,38 +12460,40 @@ "text": "ExpressionAstExpression" } ], - "description": [], "source": { "path": "src/plugins/expressions/common/executor/executor.ts", "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": 240 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 240 - } + "returnComment": [] }, { + "parentPluginId": "expressions", "id": "def-server.Executor.migrate", "type": "Function", + "tags": [], "label": "migrate", + "description": [], "signature": [ "(ast: ", { @@ -11208,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", @@ -11224,38 +12534,40 @@ "text": "SerializableState" } ], - "description": [], "source": { "path": "src/plugins/expressions/common/executor/executor.ts", "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": 248 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 248 - } + "returnComment": [] }, { + "parentPluginId": "expressions", "id": "def-server.Executor.fork", "type": "Function", + "tags": [], "label": "fork", + "description": [], "signature": [ "() => ", { @@ -11267,23 +12579,19 @@ }, "" ], - "description": [], - "children": [], - "tags": [], - "returnComment": [], "source": { "path": "src/plugins/expressions/common/executor/executor.ts", "lineNumber": 257 - } + }, + "deprecated": false, + "children": [], + "returnComment": [] } ], - "source": { - "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 81 - }, "initialIsOpen": false }, { + "parentPluginId": "expressions", "id": "def-server.ExpressionFunction", "type": "Class", "tags": [], @@ -11315,11 +12623,17 @@ }, "[]>>" ], + "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" @@ -11327,28 +12641,32 @@ "source": { "path": "src/plugins/expressions/common/expression_functions/expression_function.ts", "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": 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." @@ -11356,28 +12674,32 @@ "source": { "path": "src/plugins/expressions/common/expression_functions/expression_function.ts", "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": 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." @@ -11385,59 +12707,63 @@ "source": { "path": "src/plugins/expressions/common/expression_functions/expression_function.ts", "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": 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": 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": 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": 56 - }, "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": 60 - }, "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": 63 - }, "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": 67 - }, "signature": [ "{ [key: string]: (state: ", { @@ -11542,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", @@ -11567,204 +12913,237 @@ "text": "AnyExpressionFunctionDefinition" } ], - "description": [], "source": { "path": "src/plugins/expressions/common/expression_functions/expression_function.ts", "lineNumber": 71 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/expressions/common/expression_functions/expression_function.ts", - "lineNumber": 71 - } + "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": 105 - } + }, + "deprecated": false, + "isRequired": true } ], - "signature": [ - "(type: string) => boolean" - ], - "description": [], - "label": "accepts", - "source": { - "path": "src/plugins/expressions/common/expression_functions/expression_function.ts", - "lineNumber": 105 - }, - "tags": [], "returnComment": [] } ], - "source": { - "path": "src/plugins/expressions/common/expression_functions/expression_function.ts", - "lineNumber": 17 - }, "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", @@ -11775,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": [], @@ -11843,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: ", { @@ -11922,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", @@ -11948,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": [], @@ -12001,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: ", { @@ -12025,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", @@ -12050,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) => ", { @@ -12079,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": [ "() => ", { @@ -12142,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": [], @@ -12198,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", @@ -12217,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", @@ -12243,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: ", { @@ -12280,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", @@ -12297,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: ", { @@ -12333,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", @@ -12349,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": [], @@ -12426,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", @@ -12445,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", @@ -12471,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: ", { @@ -12508,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", @@ -12525,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: ", { @@ -12561,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", @@ -12577,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." @@ -12643,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", @@ -12728,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) => ", { @@ -12772,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) => ", { @@ -12811,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": [], @@ -13057,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", @@ -13082,24 +14608,23 @@ }, "" ], - "description": [], "source": { "path": "src/plugins/expressions/common/executor/executor.ts", "lineNumber": 60 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 60 - } + "returnComment": [] }, { + "parentPluginId": "expressions", "id": "def-server.FunctionsRegistry.register", "type": "Function", + "tags": [], "label": "register", + "description": [], "signature": [ "(functionDefinition: ", { @@ -13119,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", @@ -13144,24 +14675,23 @@ }, ")" ], - "description": [], "source": { "path": "src/plugins/expressions/common/executor/executor.ts", "lineNumber": 63 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 62 - } + "returnComment": [] }, { + "parentPluginId": "expressions", "id": "def-server.FunctionsRegistry.get", "type": "Function", + "tags": [], "label": "get", + "description": [], "signature": [ "(id: string) => ", { @@ -13173,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": 68 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 68 - } + "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": 72 - } + }, + "deprecated": false, + "children": [], + "returnComment": [] }, { + "parentPluginId": "expressions", "id": "def-server.FunctionsRegistry.toArray", "type": "Function", + "tags": [], "label": "toArray", + "description": [], "signature": [ "() => ", { @@ -13236,23 +14773,19 @@ }, "[]" ], - "description": [], - "children": [], - "tags": [], - "returnComment": [], "source": { "path": "src/plugins/expressions/common/executor/executor.ts", "lineNumber": 76 - } + }, + "deprecated": false, + "children": [], + "returnComment": [] } ], - "source": { - "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 59 - }, "initialIsOpen": false }, { + "parentPluginId": "expressions", "id": "def-server.TypesRegistry", "type": "Class", "tags": [], @@ -13284,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", @@ -13309,24 +14856,23 @@ }, "" ], - "description": [], "source": { "path": "src/plugins/expressions/common/executor/executor.ts", "lineNumber": 38 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 38 - } + "returnComment": [] }, { + "parentPluginId": "expressions", "id": "def-server.TypesRegistry.register", "type": "Function", + "tags": [], "label": "register", + "description": [], "signature": [ "(typeDefinition: ", { @@ -13346,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", @@ -13371,24 +14923,23 @@ }, ")" ], - "description": [], "source": { "path": "src/plugins/expressions/common/executor/executor.ts", "lineNumber": 41 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 40 - } + "returnComment": [] }, { + "parentPluginId": "expressions", "id": "def-server.TypesRegistry.get", "type": "Function", + "tags": [], "label": "get", + "description": [], "signature": [ "(id: string) => ", { @@ -13400,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": 46 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 46 - } + "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": 50 - } + }, + "deprecated": false, + "children": [], + "returnComment": [] }, { + "parentPluginId": "expressions", "id": "def-server.TypesRegistry.toArray", "type": "Function", + "tags": [], "label": "toArray", + "description": [], "signature": [ "() => ", { @@ -13463,28 +15021,30 @@ }, "[]" ], - "description": [], - "children": [], - "tags": [], - "returnComment": [], "source": { "path": "src/plugins/expressions/common/executor/executor.ts", "lineNumber": 54 - } + }, + "deprecated": false, + "children": [], + "returnComment": [] } ], - "source": { - "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 37 - }, "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 | ", { @@ -13519,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 | ", { @@ -13555,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: ", { @@ -13615,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", @@ -13634,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] | ", { @@ -13666,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 ", { @@ -13702,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 ", { @@ -13734,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: ", { @@ -13764,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", @@ -13782,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\" ? ", { @@ -13861,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) => ", { @@ -13914,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", @@ -13987,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", @@ -14059,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", @@ -14082,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": [ "(() => ", { @@ -14213,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." ], + "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": 72 - }, "signature": [ { "pluginId": "expressions", @@ -14264,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": 73 - }, "signature": [ { "pluginId": "expressions", @@ -14285,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": 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": 75 - }, "signature": [ { "pluginId": "expressions", @@ -14319,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": 71 - }, "initialIsOpen": false }, { + "parentPluginId": "expressions", "id": "def-server.ExecutionState", "type": "Interface", + "tags": [], "label": "ExecutionState", + "description": [], "signature": [ { "pluginId": "expressions", @@ -14350,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", @@ -14371,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", @@ -14442,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", @@ -14562,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": [ "() => ", { @@ -14637,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", @@ -14678,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", @@ -14718,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: ", { @@ -14760,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) => (", { @@ -14786,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: (", { @@ -14812,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": [ "() => ", { @@ -14855,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", @@ -14912,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\" | ", { @@ -14973,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", @@ -14996,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]: ", { @@ -15020,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." @@ -15049,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", @@ -15170,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", @@ -15190,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", @@ -15210,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", @@ -15230,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", @@ -15250,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", @@ -15270,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", @@ -15290,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", @@ -15310,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", @@ -15383,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." @@ -15397,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." @@ -15458,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: ", { @@ -15482,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", @@ -15505,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]: ", { @@ -15586,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]: ", { @@ -15608,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", @@ -15672,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": [ "() => ", { @@ -15848,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", @@ -15901,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", @@ -16114,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", @@ -16152,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": 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": 57 }, - "signature": [ - "TParams | undefined" - ] + "deprecated": false } ], - "source": { - "path": "src/plugins/expressions/common/types/common.ts", - "lineNumber": 55 - }, "initialIsOpen": false } ], "enums": [ { + "parentPluginId": "expressions", "id": "def-server.FontStyle", "type": "Enum", - "label": "FontStyle", "tags": [], + "label": "FontStyle", "description": [ "\nEnum of supported CSS `font-style` properties." ], @@ -16206,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." ], @@ -16220,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." ], @@ -16234,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." ], @@ -16248,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." ], @@ -16262,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<", { @@ -16291,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\" | \"unknown\" | \"_source\" | \"attachment\" | \"geo_point\" | \"geo_shape\" | \"murmur3\" | \"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 | ", { @@ -16409,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 | ", { @@ -16469,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<", { @@ -16745,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": [ - "(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" - ], + "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\" | ", { @@ -16817,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" ], + "signature": [ + "\"date\" | \"filter\"" + ], "source": { "path": "src/plugins/expressions/common/types/common.ts", "lineNumber": 48 }, - "signature": [ - "\"date\" | \"filter\"" - ], + "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) => ", { @@ -16890,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 } @@ -16913,6 +18911,7 @@ "common": { "classes": [ { + "parentPluginId": "expressions", "id": "def-common.Execution", "type": "Class", "tags": [], @@ -16928,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": 94 - }, "signature": [ { "pluginId": "expressions", @@ -16974,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": 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": 113 - }, "signature": [ { "pluginId": "expressions", @@ -17015,20 +19020,22 @@ "" - ] + ], + "source": { + "path": "src/plugins/expressions/common/execution/execution.ts", + "lineNumber": 113 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-common.Execution.result", "type": "Object", + "tags": [], "label": "result", "description": [ "\nFuture that tracks result or error of this execution." ], - "source": { - "path": "src/plugins/expressions/common/execution/execution.ts", - "lineNumber": 140 - }, "signature": [ "Observable", ">" - ] + ], + "source": { + "path": "src/plugins/expressions/common/execution/execution.ts", + "lineNumber": 140 + }, + "deprecated": false }, { - "tags": [], + "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." ], - "source": { - "path": "src/plugins/expressions/common/execution/execution.ts", - "lineNumber": 153 - }, "signature": [ { "pluginId": "expressions", @@ -17079,47 +19088,65 @@ "text": "ExecutionContract" }, "" - ] + ], + "source": { + "path": "src/plugins/expressions/common/execution/execution.ts", + "lineNumber": 153 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "expressions", "id": "def-common.Execution.expression", "type": "string", + "tags": [], "label": "expression", "description": [], "source": { "path": "src/plugins/expressions/common/execution/execution.ts", "lineNumber": 159 - } + }, + "deprecated": false }, { + "parentPluginId": "expressions", "id": "def-common.Execution.inspectorAdapters", "type": "Uncategorized", - "label": "inspectorAdapters", "tags": [], + "label": "inspectorAdapters", "description": [], + "signature": [ + "InspectorAdapters" + ], "source": { "path": "src/plugins/expressions/common/execution/execution.ts", "lineNumber": 161 }, - "signature": [ - "InspectorAdapters" - ] + "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", @@ -17129,42 +19156,45 @@ "text": "ExecutionParams" } ], - "description": [], "source": { "path": "src/plugins/expressions/common/execution/execution.ts", "lineNumber": 165 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/expressions/common/execution/execution.ts", - "lineNumber": 165 - } + "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": 229 - } + }, + "deprecated": false, + "children": [], + "returnComment": [] }, { + "parentPluginId": "expressions", "id": "def-common.Execution.start", "type": "Function", + "tags": [], "label": "start", + "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", @@ -17194,36 +19224,39 @@ }, " | undefined; }>>" ], - "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." - ], + "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": 239 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/expressions/common/execution/execution.ts", - "lineNumber": 239 - } + "returnComment": [] }, { + "parentPluginId": "expressions", "id": "def-common.Execution.invokeChain", "type": "Function", + "tags": [], "label": "invokeChain", + "description": [], "signature": [ "(chainArr: ", { @@ -17237,13 +19270,19 @@ "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", @@ -17254,38 +19293,40 @@ }, "[]" ], - "description": [], "source": { "path": "src/plugins/expressions/common/execution/execution.ts", "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": 263 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/expressions/common/execution/execution.ts", - "lineNumber": 263 - } + "returnComment": [] }, { + "parentPluginId": "expressions", "id": "def-common.Execution.invokeFunction", "type": "Function", + "tags": [], "label": "invokeFunction", + "description": [], "signature": [ "(fn: ", { @@ -17299,13 +19340,19 @@ "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", @@ -17315,97 +19362,110 @@ "text": "ExpressionFunction" } ], - "description": [], "source": { "path": "src/plugins/expressions/common/execution/execution.ts", "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": 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": 339 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/expressions/common/execution/execution.ts", - "lineNumber": 336 - } + "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": 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": 374 - } + }, + "deprecated": false, + "isRequired": false } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/expressions/common/execution/execution.ts", - "lineNumber": 374 - } + "returnComment": [] }, { + "parentPluginId": "expressions", "id": "def-common.Execution.resolveArgs", "type": "Function", + "tags": [], "label": "resolveArgs", + "description": [], "signature": [ "(fnDef: ", { @@ -17419,13 +19479,19 @@ "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", @@ -17435,52 +19501,57 @@ "text": "ExpressionFunction" } ], - "description": [], "source": { "path": "src/plugins/expressions/common/execution/execution.ts", "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": 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": 400 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/expressions/common/execution/execution.ts", - "lineNumber": 400 - } + "returnComment": [] }, { + "parentPluginId": "expressions", "id": "def-common.Execution.interpret", "type": "Function", + "tags": [], "label": "interpret", + "description": [], "signature": [ "(ast: ", { @@ -17494,13 +19565,19 @@ "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", @@ -17510,42 +19587,38 @@ "text": "ExpressionAstNode" } ], - "description": [], "source": { "path": "src/plugins/expressions/common/execution/execution.ts", "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": 489 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/expressions/common/execution/execution.ts", - "lineNumber": 489 - } + "returnComment": [] } ], - "source": { - "path": "src/plugins/expressions/common/execution/execution.ts", - "lineNumber": 84 - }, "initialIsOpen": false }, { + "parentPluginId": "expressions", "id": "def-common.ExecutionContract", "type": "Class", "tags": [], @@ -17563,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": 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", @@ -17599,42 +19688,45 @@ }, "" ], - "description": [], "source": { "path": "src/plugins/expressions/common/execution/execution_contract.ts", "lineNumber": 26 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/expressions/common/execution/execution_contract.ts", - "lineNumber": 26 - } + "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": 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<", { @@ -17662,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": 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": 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": [ "() => ", { @@ -17705,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": 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": 78 }, - "tags": [], + "deprecated": false, + "children": [], "returnComment": [] } ], - "source": { - "path": "src/plugins/expressions/common/execution/execution_contract.ts", - "lineNumber": 19 - }, "initialIsOpen": false }, { + "parentPluginId": "expressions", "id": "def-common.Executor", "type": "Class", "tags": [], @@ -17773,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 ", { @@ -17789,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", @@ -17806,30 +19912,23 @@ }, " | undefined" ], - "description": [], "source": { "path": "src/plugins/expressions/common/executor/executor.ts", "lineNumber": 84 - } + }, + "deprecated": false, + "isRequired": false } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 83 - } + "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": 92 - }, "signature": [ { "pluginId": "expressions", @@ -17839,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": 97 - }, "signature": [ { "pluginId": "expressions", @@ -17861,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": 102 - }, "signature": [ { "pluginId": "expressions", @@ -17883,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", @@ -17909,24 +20028,23 @@ }, " | undefined" ], - "description": [], "source": { "path": "src/plugins/expressions/common/executor/executor.ts", "lineNumber": 104 - } + }, + "deprecated": false, + "isRequired": false } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 104 - } + "returnComment": [] }, { + "parentPluginId": "expressions", "id": "def-common.Executor.registerFunction", "type": "Function", + "tags": [], "label": "registerFunction", + "description": [], "signature": [ "(functionDefinition: ", { @@ -17946,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", @@ -17971,24 +20095,23 @@ }, ")" ], - "description": [], "source": { "path": "src/plugins/expressions/common/executor/executor.ts", "lineNumber": 111 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 110 - } + "returnComment": [] }, { + "parentPluginId": "expressions", "id": "def-common.Executor.getFunction", "type": "Function", + "tags": [], "label": "getFunction", + "description": [], "signature": [ "(name: string) => ", { @@ -18000,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": 119 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 119 - } + "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": 123 - } + }, + "deprecated": false, + "children": [], + "returnComment": [] }, { + "parentPluginId": "expressions", "id": "def-common.Executor.registerType", "type": "Function", + "tags": [], "label": "registerType", + "description": [], "signature": [ "(typeDefinition: ", { @@ -18071,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", @@ -18096,24 +20232,23 @@ }, ")" ], - "description": [], "source": { "path": "src/plugins/expressions/common/executor/executor.ts", "lineNumber": 128 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 127 - } + "returnComment": [] }, { + "parentPluginId": "expressions", "id": "def-common.Executor.getType", "type": "Function", + "tags": [], "label": "getType", + "description": [], "signature": [ "(name: string) => ", { @@ -18125,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": 136 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 136 - } + "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": 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": 144 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 144 - } + "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": 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 | ", { @@ -18258,15 +20409,21 @@ "text": "ErrorLike" } ], - "description": [ - "\nExecute expression and return result.\n" - ], + "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 | ", { @@ -18277,35 +20434,39 @@ "text": "ExpressionAstExpression" } ], - "description": [ - "Expression AST or a string representing expression." - ], "source": { "path": "src/plugins/expressions/common/executor/executor.ts", "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": 162 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "expressions", "id": "def-common.Executor.run.$3", "type": "Object", + "tags": [], "label": "params", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "expressions", @@ -18315,24 +20476,23 @@ "text": "ExpressionExecutionParams" } ], - "description": [], "source": { "path": "src/plugins/expressions/common/executor/executor.ts", "lineNumber": 163 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 160 - } + "returnComment": [] }, { + "parentPluginId": "expressions", "id": "def-common.Executor.createExecution", "type": "Function", + "tags": [], "label": "createExecution", + "description": [], "signature": [ "(ast: string | ", { @@ -18368,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 | ", { @@ -18385,17 +20551,20 @@ "text": "ExpressionAstExpression" } ], - "description": [], "source": { "path": "src/plugins/expressions/common/executor/executor.ts", "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", @@ -18405,24 +20574,23 @@ "text": "ExpressionExecutionParams" } ], - "description": [], "source": { "path": "src/plugins/expressions/common/executor/executor.ts", "lineNumber": 170 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 168 - } + "returnComment": [] }, { + "parentPluginId": "expressions", "id": "def-common.Executor.inject", "type": "Function", + "tags": [], "label": "inject", + "description": [], "signature": [ "(ast: ", { @@ -18443,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", @@ -18459,39 +20633,41 @@ "text": "ExpressionAstExpression" } ], - "description": [], "source": { "path": "src/plugins/expressions/common/executor/executor.ts", "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": 216 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 216 - } + "returnComment": [] }, { + "parentPluginId": "expressions", "id": "def-common.Executor.extract", "type": "Function", + "tags": [], "label": "extract", + "description": [], "signature": [ "(ast: ", { @@ -18513,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", @@ -18529,24 +20711,23 @@ "text": "ExpressionAstExpression" } ], - "description": [], "source": { "path": "src/plugins/expressions/common/executor/executor.ts", "lineNumber": 229 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 229 - } + "returnComment": [] }, { + "parentPluginId": "expressions", "id": "def-common.Executor.telemetry", "type": "Function", + "tags": [], "label": "telemetry", + "description": [], "signature": [ "(ast: ", { @@ -18558,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", @@ -18574,38 +20761,40 @@ "text": "ExpressionAstExpression" } ], - "description": [], "source": { "path": "src/plugins/expressions/common/executor/executor.ts", "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": 240 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 240 - } + "returnComment": [] }, { + "parentPluginId": "expressions", "id": "def-common.Executor.migrate", "type": "Function", + "tags": [], "label": "migrate", + "description": [], "signature": [ "(ast: ", { @@ -18624,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", @@ -18640,38 +20835,40 @@ "text": "SerializableState" } ], - "description": [], "source": { "path": "src/plugins/expressions/common/executor/executor.ts", "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": 248 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 248 - } + "returnComment": [] }, { + "parentPluginId": "expressions", "id": "def-common.Executor.fork", "type": "Function", + "tags": [], "label": "fork", + "description": [], "signature": [ "() => ", { @@ -18683,23 +20880,19 @@ }, "" ], - "description": [], - "children": [], - "tags": [], - "returnComment": [], "source": { "path": "src/plugins/expressions/common/executor/executor.ts", "lineNumber": 257 - } + }, + "deprecated": false, + "children": [], + "returnComment": [] } ], - "source": { - "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 81 - }, "initialIsOpen": false }, { + "parentPluginId": "expressions", "id": "def-common.ExpressionFunction", "type": "Class", "tags": [], @@ -18731,11 +20924,17 @@ }, "[]>>" ], + "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" @@ -18743,28 +20942,32 @@ "source": { "path": "src/plugins/expressions/common/expression_functions/expression_function.ts", "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": 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." @@ -18772,28 +20975,32 @@ "source": { "path": "src/plugins/expressions/common/expression_functions/expression_function.ts", "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": 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." @@ -18801,59 +21008,63 @@ "source": { "path": "src/plugins/expressions/common/expression_functions/expression_function.ts", "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": 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": 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": 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": 56 - }, "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": 60 - }, "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": 63 - }, "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": 67 - }, "signature": [ "{ [key: string]: (state: ", { @@ -18958,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", @@ -18983,204 +21214,237 @@ "text": "AnyExpressionFunctionDefinition" } ], - "description": [], "source": { "path": "src/plugins/expressions/common/expression_functions/expression_function.ts", "lineNumber": 71 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/expressions/common/expression_functions/expression_function.ts", - "lineNumber": 71 - } + "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": 105 - } + }, + "deprecated": false, + "isRequired": true } ], - "signature": [ - "(type: string) => boolean" - ], - "description": [], - "label": "accepts", - "source": { - "path": "src/plugins/expressions/common/expression_functions/expression_function.ts", - "lineNumber": 105 - }, - "tags": [], "returnComment": [] } ], - "source": { - "path": "src/plugins/expressions/common/expression_functions/expression_function.ts", - "lineNumber": 17 - }, "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", @@ -19191,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": [], @@ -19259,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: ", { @@ -19338,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", @@ -19364,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": [], @@ -19417,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: ", { @@ -19441,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", @@ -19466,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) => ", { @@ -19495,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": [ "() => ", { @@ -19558,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": [], @@ -19591,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": [], @@ -19678,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": 176 - }, "signature": [ { "pluginId": "expressions", @@ -19698,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": 177 - }, "signature": [ { "pluginId": "expressions", @@ -19718,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", @@ -19743,29 +22067,57 @@ "text": "ExpressionServiceParams" } ], - "description": [], "source": { "path": "src/plugins/expressions/common/service/expressions_services.ts", "lineNumber": 179 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/expressions/common/service/expressions_services.ts", - "lineNumber": 179 - } + "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", @@ -19784,52 +22136,55 @@ }, ")" ], - "description": [], "source": { "path": "src/plugins/expressions/common/service/expressions_services.ts", "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": 219 + "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", @@ -19848,50 +22203,55 @@ }, ")" ], - "description": [], "source": { "path": "src/plugins/expressions/common/service/expressions_services.ts", "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": 223 + "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", @@ -19910,50 +22270,55 @@ }, ")" ], - "description": [], "source": { "path": "src/plugins/expressions/common/service/expressions_services.ts", "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": 227 + "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 | ", { @@ -19964,31 +22329,37 @@ "text": "ExpressionAstExpression" } ], - "description": [], "source": { "path": "src/plugins/expressions/common/service/expressions_services.ts", "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": 231 - } + }, + "deprecated": false, + "isRequired": true }, { + "parentPluginId": "expressions", "id": "def-common.ExpressionsService.run.$3", "type": "Object", + "tags": [], "label": "params", - "isRequired": false, + "description": [], "signature": [ { "pluginId": "expressions", @@ -19999,84 +22370,69 @@ }, " | undefined" ], - "description": [], "source": { "path": "src/plugins/expressions/common/service/expressions_services.ts", "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": 231 + "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": 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": 234 - }, - "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": 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": 244 - } - } - ], + "tags": [], + "label": "getRenderer", + "description": [], "signature": [ "(name: string) => ", { @@ -20129,19 +22470,41 @@ }, " | null" ], - "description": [], - "label": "getRenderer", "source": { "path": "src/plugins/expressions/common/service/expressions_services.ts", "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": 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": 254 - } - } - ], + "tags": [], + "label": "getType", + "description": [], "signature": [ "(name: string) => ", { @@ -20194,19 +22542,41 @@ }, " | undefined" ], - "description": [], - "label": "getType", "source": { "path": "src/plugins/expressions/common/service/expressions_services.ts", "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": 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": 263 - }, "signature": [ "(ast: string | ", { @@ -20265,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": [ "() => ", { @@ -20281,24 +22653,47 @@ "text": "ExpressionsService" } ], - "description": [], - "label": "fork", "source": { "path": "src/plugins/expressions/common/service/expressions_services.ts", "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", @@ -20308,58 +22703,76 @@ "text": "ExpressionAstExpression" } ], - "description": [], "source": { "path": "src/plugins/expressions/common/service/expressions_services.ts", "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": 283 - } + }, + "deprecated": false, + "isRequired": true } ], - "signature": [ - "(state: ", - { - "pluginId": "expressions", - "scope": "common", + "returnComment": [] + }, + { + "parentPluginId": "expressions", + "id": "def-common.ExpressionsService.extract", + "type": "Function", + "tags": [], + "label": "extract", + "description": [ + "\nExtracts saved object references from expression AST" + ], + "signature": [ + "(state: ", + { + "pluginId": "expressions", + "scope": "common", "docId": "kibExpressionsPluginApi", "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": 281 + "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", @@ -20369,13 +22782,27 @@ "text": "ExpressionAstExpression" } ], - "description": [], "source": { "path": "src/plugins/expressions/common/service/expressions_services.ts", "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: ", { @@ -20385,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": 293 + "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", @@ -20428,40 +22845,55 @@ "text": "ExpressionAstExpression" } ], - "description": [], "source": { "path": "src/plugins/expressions/common/service/expressions_services.ts", "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": 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", @@ -20470,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": 303 + "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", @@ -20501,62 +22924,44 @@ "text": "SerializableState" } ], - "description": [], "source": { "path": "src/plugins/expressions/common/service/expressions_services.ts", "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": 313 - } - } - ], - "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" + }, + "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": 313 - }, - "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<", { @@ -20568,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": 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": [ "() => ", { @@ -20593,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": 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": 333 - } + }, + "deprecated": false, + "children": [], + "returnComment": [] } ], - "source": { - "path": "src/plugins/expressions/common/service/expressions_services.ts", - "lineNumber": 175 - }, "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." @@ -20656,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", @@ -20741,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) => ", { @@ -20785,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) => ", { @@ -20824,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": [], @@ -21070,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", @@ -21095,24 +23570,23 @@ }, "" ], - "description": [], "source": { "path": "src/plugins/expressions/common/executor/executor.ts", "lineNumber": 60 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 60 - } + "returnComment": [] }, { + "parentPluginId": "expressions", "id": "def-common.FunctionsRegistry.register", "type": "Function", + "tags": [], "label": "register", + "description": [], "signature": [ "(functionDefinition: ", { @@ -21132,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", @@ -21157,24 +23637,23 @@ }, ")" ], - "description": [], "source": { "path": "src/plugins/expressions/common/executor/executor.ts", "lineNumber": 63 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 62 - } + "returnComment": [] }, { + "parentPluginId": "expressions", "id": "def-common.FunctionsRegistry.get", "type": "Function", + "tags": [], "label": "get", + "description": [], "signature": [ "(id: string) => ", { @@ -21186,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": 68 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 68 - } + "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": 72 - } + }, + "deprecated": false, + "children": [], + "returnComment": [] }, { + "parentPluginId": "expressions", "id": "def-common.FunctionsRegistry.toArray", "type": "Function", + "tags": [], "label": "toArray", + "description": [], "signature": [ "() => ", { @@ -21249,23 +23735,19 @@ }, "[]" ], - "description": [], - "children": [], - "tags": [], - "returnComment": [], "source": { "path": "src/plugins/expressions/common/executor/executor.ts", "lineNumber": 76 - } + }, + "deprecated": false, + "children": [], + "returnComment": [] } ], - "source": { - "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 59 - }, "initialIsOpen": false }, { + "parentPluginId": "expressions", "id": "def-common.TablesAdapter", "type": "Class", "tags": [], @@ -21282,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: ", { @@ -21298,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", @@ -21328,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]: ", { @@ -21362,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": [], @@ -21403,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", @@ -21428,24 +23936,23 @@ }, "" ], - "description": [], "source": { "path": "src/plugins/expressions/common/executor/executor.ts", "lineNumber": 38 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 38 - } + "returnComment": [] }, { + "parentPluginId": "expressions", "id": "def-common.TypesRegistry.register", "type": "Function", + "tags": [], "label": "register", + "description": [], "signature": [ "(typeDefinition: ", { @@ -21465,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", @@ -21490,24 +24003,23 @@ }, ")" ], - "description": [], "source": { "path": "src/plugins/expressions/common/executor/executor.ts", "lineNumber": 41 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 40 - } + "returnComment": [] }, { + "parentPluginId": "expressions", "id": "def-common.TypesRegistry.get", "type": "Function", + "tags": [], "label": "get", + "description": [], "signature": [ "(id: string) => ", { @@ -21519,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": 46 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 46 - } + "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": 50 - } + }, + "deprecated": false, + "children": [], + "returnComment": [] }, { + "parentPluginId": "expressions", "id": "def-common.TypesRegistry.toArray", "type": "Function", + "tags": [], "label": "toArray", + "description": [], "signature": [ "() => ", { @@ -21582,28 +24101,30 @@ }, "[]" ], - "description": [], - "children": [], - "tags": [], - "returnComment": [], "source": { "path": "src/plugins/expressions/common/executor/executor.ts", "lineNumber": 54 - } + }, + "deprecated": false, + "children": [], + "returnComment": [] } ], - "source": { - "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 37 - }, "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 | ", { @@ -21638,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 | ", { @@ -21674,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: ", { @@ -21734,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", @@ -21753,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] | ", { @@ -21785,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: ", { @@ -21829,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", @@ -21847,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 | ", { @@ -21997,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?: ", { @@ -22052,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?: ", { @@ -22107,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": [ "() => ", { @@ -22142,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 ", { @@ -22167,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 ", { @@ -22199,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: ", { @@ -22229,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", @@ -22247,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 ", @@ -22421,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 ", { @@ -22519,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\" ? ", { @@ -22551,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) => ", { @@ -22604,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}: ", { @@ -22696,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", @@ -22713,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", @@ -22827,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", @@ -22847,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", @@ -22881,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", @@ -22974,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", @@ -22995,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", @@ -23030,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", @@ -23051,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", @@ -23166,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", @@ -23238,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", @@ -23274,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", @@ -23329,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", @@ -23392,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", @@ -23415,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", @@ -23435,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", @@ -23522,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": [ "(() => ", { @@ -23653,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": 72 - }, "signature": [ { "pluginId": "expressions", @@ -23704,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": 73 - }, "signature": [ { "pluginId": "expressions", @@ -23725,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": 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": 75 - }, "signature": [ { "pluginId": "expressions", @@ -23759,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": 71 - }, "initialIsOpen": false }, { + "parentPluginId": "expressions", "id": "def-common.ExecutionPureTransitions", "type": "Interface", + "tags": [], "label": "ExecutionPureTransitions", + "description": [], "signature": [ { "pluginId": "expressions", @@ -23782,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: ", { @@ -23813,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: ", { @@ -23843,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: ", { @@ -23873,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", @@ -23904,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", @@ -23925,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: ", { @@ -24017,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: ", { @@ -24047,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: ", { @@ -24069,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: ", { @@ -24121,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: ", { @@ -24159,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: ", { @@ -24189,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", @@ -24212,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", @@ -24332,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": [ "() => ", { @@ -24407,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", @@ -24448,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", @@ -24488,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: ", { @@ -24530,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) => (", { @@ -24556,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: (", { @@ -24582,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": [ "() => ", { @@ -24625,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": 34 }, - "signature": [ - "boolean | undefined" - ] + "deprecated": false } ], - "source": { - "path": "src/plugins/expressions/common/executor/executor.ts", - "lineNumber": 28 - }, "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": 43 - }, "signature": [ { "pluginId": "kibanaUtils", @@ -24708,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": 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": 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": 59 - }, "signature": [ { "pluginId": "core", @@ -24761,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": 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": 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": 65 - }, "signature": [ { "pluginId": "inspector", @@ -24810,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": 42 - }, "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", @@ -24849,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\" | ", { @@ -24910,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", @@ -24933,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]: ", { @@ -24957,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." @@ -24986,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", @@ -25107,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", @@ -25127,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", @@ -25147,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", @@ -25167,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", @@ -25187,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", @@ -25207,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", @@ -25227,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", @@ -25247,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", @@ -25320,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." @@ -25334,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." @@ -25395,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: ", { @@ -25419,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": 152 - }, "signature": [ { "pluginId": "expressions", @@ -25454,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": 153 - }, "signature": [ { "pluginId": "expressions", @@ -25475,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": 151 - }, "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": 79 - }, "signature": [ "(name: string) => ", { @@ -25515,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": 87 - }, "signature": [ "(name: string) => ", { @@ -25539,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": 95 - }, "signature": [ "(name: string) => ", { @@ -25563,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": 121 - }, "signature": [ "(ast: string | ", { @@ -25595,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": 132 - }, "signature": [ "(ast: string | ", { @@ -25635,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": 148 - }, "signature": [ "() => ", { @@ -25658,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": 72 - }, "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", @@ -25681,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]: ", { @@ -25762,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]: ", { @@ -25784,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", @@ -25848,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": [ "() => ", { @@ -26024,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", @@ -26077,115 +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": 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": 17 - } + }, + "deprecated": false }, { + "parentPluginId": "expressions", "id": "def-common.MapColumnArguments.expression", "type": "Function", + "tags": [], "label": "expression", + "description": [], "signature": [ "((datatable: ", { @@ -26199,13 +29284,19 @@ "Observable", ") | undefined" ], - "description": [], + "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", - "isRequired": true, + "description": [], "signature": [ { "pluginId": "expressions", @@ -26215,239 +29306,266 @@ "text": "Datatable" } ], - "description": [], "source": { "path": "src/plugins/expressions/common/expression_functions/specs/map_column.ts", "lineNumber": 18 - } + }, + "deprecated": false, + "isRequired": true } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/expressions/common/expression_functions/specs/map_column.ts", - "lineNumber": 18 - } + "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": 19 }, - "signature": [ - "string | null | undefined" - ] + "deprecated": false } ], - "source": { - "path": "src/plugins/expressions/common/expression_functions/specs/map_column.ts", - "lineNumber": 15 - }, "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", @@ -26465,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", @@ -26503,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": 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": 57 }, - "signature": [ - "TParams | undefined" - ] + "deprecated": false } ], - "source": { - "path": "src/plugins/expressions/common/types/common.ts", - "lineNumber": 55 - }, "initialIsOpen": false } ], "enums": [ { + "parentPluginId": "expressions", "id": "def-common.BackgroundRepeat", "type": "Enum", - "label": "BackgroundRepeat", "tags": [], + "label": "BackgroundRepeat", "description": [ "\nEnum of supported CSS `background-repeat` properties." ], @@ -26557,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." ], @@ -26571,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." ], @@ -26585,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." ], @@ -26599,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." ], @@ -26613,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." ], @@ -26627,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." ], @@ -26641,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<", { @@ -26670,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\" | \"unknown\" | \"_source\" | \"attachment\" | \"geo_point\" | \"geo_shape\" | \"murmur3\" | \"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 | ", { @@ -26818,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?: ", { @@ -26887,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 | ", { @@ -26917,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, ", { @@ -26950,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, ", { @@ -26983,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, ", { @@ -27016,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, ", { @@ -27057,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, ", { @@ -27090,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, ", { @@ -27123,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, ", { @@ -27156,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, ", { @@ -27189,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": 27 - }, "signature": [ "{ readonly getType: (name: string) => ", { @@ -27245,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", @@ -27442,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 | ", { @@ -27528,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<", { @@ -27595,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", @@ -27696,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": [ - "(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" - ], + "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\" | ", { @@ -27738,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" ], + "signature": [ + "\"date\" | \"filter\"" + ], "source": { "path": "src/plugins/expressions/common/types/common.ts", "lineNumber": 48 }, - "signature": [ - "\"date\" | \"filter\"" - ], + "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) => ", { @@ -27964,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) => ", { @@ -28002,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: ", { @@ -28463,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", @@ -28479,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", @@ -28499,108 +32041,93 @@ "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 - } - } - ], - "signature": [ - "(table: ", + "tags": [], + "label": "serialize", + "description": [], + "signature": [ + "(table: ", { "pluginId": "expressions", "scope": "common", @@ -28618,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: ", { @@ -28671,45 +32203,108 @@ }, "[]; }" ], - "description": [], - "label": "deserialize", "source": { "path": "src/plugins/expressions/common/expression_types/specs/datatable.ts", "lineNumber": 136 }, - "tags": [], + "deprecated": false, + "children": [ + { + "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", - "children": [], + "tags": [], + "label": "null", + "description": [], "signature": [ "() => { type: \"datatable\"; meta: {}; rows: never[]; columns: never[]; }" ], - "description": [], - "label": "null", "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", @@ -28728,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: ", { @@ -28820,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", @@ -28847,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: ", { @@ -28881,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: ", { @@ -29280,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", @@ -29296,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", @@ -29316,114 +32960,87 @@ "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 - } - } - ], - "signature": [ - "(input: ", + "tags": [], + "label": "render", + "description": [], + "signature": [ + "(input: ", { "pluginId": "expressions", "scope": "common", @@ -29464,63 +33081,80 @@ "text": "ExpressionValueBoxed" } ], - "description": [], - "label": "render", "source": { "path": "src/plugins/expressions/common/expression_types/specs/error.ts", "lineNumber": 38 }, - "tags": [], + "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": "to", - "source": { - "path": "src/plugins/expressions/common/expression_types/specs/error.ts", - "lineNumber": 37 - } + ] } ], - "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: ", { @@ -29556,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", @@ -29584,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: ", { @@ -29626,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", @@ -29654,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: ", { @@ -29696,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", @@ -29894,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", @@ -30300,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: ", { @@ -30530,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": 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": 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": 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": 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": 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": 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": 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": 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": 50 }, - "signature": [ - "null" - ] + "deprecated": false } - ], - "description": [], - "label": "id", - "source": { - "path": "src/plugins/expressions/common/expression_functions/specs/map_column.ts", - "lineNumber": 43 - } + ] }, { + "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": 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": 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": 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": 58 }, - "signature": [ - "true" - ] + "deprecated": false } - ], - "description": [], - "label": "name", - "source": { - "path": "src/plugins/expressions/common/expression_functions/specs/map_column.ts", - "lineNumber": 52 - } + ] }, { + "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": 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": 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": 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": 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": 71 }, - "signature": [ - "true" - ] + "deprecated": false } - ], - "description": [], - "label": "expression", - "source": { - "path": "src/plugins/expressions/common/expression_functions/specs/map_column.ts", - "lineNumber": 60 - } + ] }, { + "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": 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": 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": 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": 80 }, - "signature": [ - "null" - ] + "deprecated": false } - ], - "description": [], - "label": "copyMetaFrom", - "source": { - "path": "src/plugins/expressions/common/expression_functions/specs/map_column.ts", - "lineNumber": 73 - } + ] } - ], - "description": [], - "label": "args", - "source": { - "path": "src/plugins/expressions/common/expression_functions/specs/map_column.ts", - "lineNumber": 42 - } + ] }, { + "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", @@ -30952,17 +34839,20 @@ "text": "Datatable" } ], - "description": [], "source": { "path": "src/plugins/expressions/common/expression_functions/specs/map_column.ts", "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", @@ -30972,242 +34862,267 @@ "text": "MapColumnArguments" } ], - "description": [], "source": { "path": "src/plugins/expressions/common/expression_functions/specs/map_column.ts", "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": 83 - }, - "tags": [], "returnComment": [] } ], - "description": [], - "label": "mapColumn", - "source": { - "path": "src/plugins/expressions/common/expression_functions/specs/map_column.ts", - "lineNumber": 22 - }, "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", @@ -31217,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", @@ -31237,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: ", { @@ -31653,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", @@ -31669,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", @@ -31689,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", + "tags": [], + "label": "string", + "description": [], + "signature": [ + "(n: any) => { type: \"num\"; value: number; }" + ], + "source": { + "path": "src/plugins/expressions/common/expression_types/specs/num.ts", + "lineNumber": 32 + }, + "deprecated": false, "children": [ { + "parentPluginId": "expressions", "id": "def-common.num.from.string.$1", "type": "Any", + "tags": [], "label": "n", - "isRequired": true, + "description": [], "signature": [ "any" ], - "description": [], "source": { "path": "src/plugins/expressions/common/expression_types/specs/num.ts", "lineNumber": 32 - } + }, + "deprecated": false, + "isRequired": true } ], - "signature": [ - "(n: any) => { type: \"num\"; value: number; }" - ], - "description": [], - "label": "string", - "source": { - "path": "src/plugins/expressions/common/expression_types/specs/num.ts", - "lineNumber": 32 - }, - "tags": [], "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 }: ", { @@ -31977,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", @@ -32005,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 }: ", { @@ -32030,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) => ", { @@ -32201,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) => ", { @@ -32239,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: ", { @@ -32446,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: ", { @@ -32521,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", @@ -32549,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: ", { @@ -32574,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", @@ -32602,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 }: ", { @@ -32620,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", @@ -32662,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: ", { @@ -32704,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", @@ -32732,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: ", { @@ -32774,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", @@ -32802,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: ", { @@ -32836,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": [ "() => ", { @@ -32892,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: ", { @@ -32958,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) => ", { @@ -33038,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: ", { @@ -33133,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) => ", { @@ -33304,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) => ", { @@ -33342,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", @@ -33643,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: ", { @@ -33823,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", @@ -33878,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: ", { @@ -34073,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", @@ -34128,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 46f6dedb000d5..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,66 +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": [], - "children": [], - "tags": [], - "returnComment": [], "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": [], "label": "enableReportingUiCapabilities", + "description": [], "signature": [ "() => void" ], - "description": [], - "children": [], - "tags": [], - "returnComment": [], "source": { "path": "x-pack/plugins/features/server/plugin.ts", "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": [ "() => ", { @@ -2060,19 +2328,21 @@ }, "[]" ], - "description": [], - "children": [], - "tags": [], - "returnComment": [], "source": { "path": "x-pack/plugins/features/server/plugin.ts", "lineNumber": 60 - } + }, + "deprecated": false, + "children": [], + "returnComment": [] }, { + "parentPluginId": "features", "id": "def-server.PluginStartContract.getKibanaFeatures", "type": "Function", + "tags": [], "label": "getKibanaFeatures", + "description": [], "signature": [ "() => ", { @@ -2084,20 +2354,15 @@ }, "[]" ], - "description": [], - "children": [], - "tags": [], - "returnComment": [], "source": { "path": "x-pack/plugins/features/server/plugin.ts", "lineNumber": 61 - } + }, + "deprecated": false, + "children": [], + "returnComment": [] } ], - "source": { - "path": "x-pack/plugins/features/server/plugin.ts", - "lineNumber": 59 - }, "initialIsOpen": false } ], @@ -2105,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 } ] @@ -2124,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", @@ -2161,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", "<", @@ -2238,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": [ "() => ", { @@ -2254,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", @@ -2296,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: ", { @@ -2323,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": [ "() => ", { @@ -2510,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: ", { @@ -2558,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: ", { @@ -2603,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: ", { @@ -2620,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" @@ -2661,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", @@ -2718,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" @@ -2979,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." @@ -2992,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: ", { @@ -3154,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 ", { @@ -3178,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" @@ -3241,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 ", { @@ -3265,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", @@ -3296,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." @@ -3312,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." @@ -3325,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", @@ -3395,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 ", { @@ -3419,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 index ffc3ff3717fd0..f149805e261de 100644 --- a/api_docs/file_data_visualizer.json +++ b/api_docs/file_data_visualizer.json @@ -8,18 +8,20 @@ "misc": [], "objects": [], "start": { + "parentPluginId": "fileDataVisualizer", "id": "def-public.FileDataVisualizerPluginStart", "type": "Type", - "label": "FileDataVisualizerPluginStart", "tags": [], + "label": "FileDataVisualizerPluginStart", "description": [], + "signature": [ + "{ getFileDataVisualizerComponent: typeof getFileDataVisualizerComponent; getMaxBytesFormatted: typeof getMaxBytesFormatted; }" + ], "source": { "path": "x-pack/plugins/file_data_visualizer/public/plugin.ts", "lineNumber": 33 }, - "signature": [ - "{ getFileDataVisualizerComponent: typeof getFileDataVisualizerComponent; getMaxBytesFormatted: typeof getMaxBytesFormatted; }" - ], + "deprecated": false, "lifecycle": "start", "initialIsOpen": true } @@ -37,252 +39,288 @@ "functions": [], "interfaces": [ { + "parentPluginId": "fileDataVisualizer", "id": "def-common.DataVisualizerTableState", "type": "Interface", + "tags": [], "label": "DataVisualizerTableState", "description": [], - "tags": [], + "source": { + "path": "x-pack/plugins/file_data_visualizer/common/types.ts", + "lineNumber": 14 + }, + "deprecated": false, "children": [ { - "tags": [], + "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 }, { - "tags": [], + "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 }, { - "tags": [], + "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 }, { - "tags": [], + "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 }, { - "tags": [], + "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 }, - "signature": [ - "string[]" - ] + "deprecated": false }, { - "tags": [], + "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 }, - "signature": [ - "string[]" - ] + "deprecated": false }, { - "tags": [], + "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 } ], - "source": { - "path": "x-pack/plugins/file_data_visualizer/common/types.ts", - "lineNumber": 14 - }, "initialIsOpen": false } ], "enums": [], "misc": [ { - "tags": [], + "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 }, - "signature": [ - "1073741274" - ], + "deprecated": false, "initialIsOpen": false }, { - "tags": [], + "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 }, - "signature": [ - "\"0,0.[0] b\"" - ], + "deprecated": false, "initialIsOpen": false }, { - "tags": [], + "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 }, - "signature": [ - "\"file-data-visualizer\"" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "fileDataVisualizer", "id": "def-common.InputData", "type": "Type", - "label": "InputData", "tags": [], + "label": "InputData", "description": [], + "signature": [ + "any[]" + ], "source": { "path": "x-pack/plugins/file_data_visualizer/common/types.ts", "lineNumber": 10 }, - "signature": [ - "any[]" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "fileDataVisualizer", "id": "def-common.JobFieldType", "type": "Type", - "label": "JobFieldType", "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 }, - "signature": [ - "\"number\" | \"boolean\" | \"date\" | \"text\" | \"keyword\" | \"ip\" | \"unknown\" | \"geo_point\" | \"geo_shape\"" - ], + "deprecated": false, "initialIsOpen": false }, { - "tags": [], + "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 }, - "signature": [ - "\"100MB\"" - ], + "deprecated": false, "initialIsOpen": false }, { - "tags": [], + "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 }, - "signature": [ - "104857600" - ], + "deprecated": false, "initialIsOpen": false }, { - "tags": [], + "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 }, { - "tags": [], + "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 }, - "signature": [ - "\"fileUpload:maxFileSize\"" - ], + "deprecated": false, "initialIsOpen": false } ], "objects": [ { - "tags": [], + "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 }, - "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\"; }" - ], + "deprecated": false, "initialIsOpen": false } ] diff --git a/api_docs/file_upload.json b/api_docs/file_upload.json index a6c1f0c6488cf..80d3add483ffc 100644 --- a/api_docs/file_upload.json +++ b/api_docs/file_upload.json @@ -5,44 +5,51 @@ "functions": [], "interfaces": [ { + "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", @@ -52,113 +59,129 @@ "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" - ] + "deprecated": false } ], - "source": { - "path": "x-pack/plugins/file_upload/public/importer/types.ts", - "lineNumber": 30 - }, "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": 24 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "fileUpload", "id": "def-public.FileUploadComponentProps.onFileSelect", "type": "Function", + "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": 25 }, - "signature": [ - "(geojsonFile: GeoJSON.FeatureCollection, name: string, previewCoverage: number) => void" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "fileUpload", "id": "def-public.FileUploadComponentProps.onFileClear", "type": "Function", + "tags": [], "label": "onFileClear", "description": [], + "signature": [ + "() => void" + ], "source": { "path": "x-pack/plugins/file_upload/public/lazy_load_bundle/index.ts", "lineNumber": 26 }, - "signature": [ - "() => void" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "fileUpload", "id": "def-public.FileUploadComponentProps.enableImportBtn", "type": "Function", + "tags": [], "label": "enableImportBtn", "description": [], + "signature": [ + "() => void" + ], "source": { "path": "x-pack/plugins/file_upload/public/lazy_load_bundle/index.ts", "lineNumber": 27 }, - "signature": [ - "() => void" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "fileUpload", "id": "def-public.FileUploadComponentProps.disableImportBtn", "type": "Function", + "tags": [], "label": "disableImportBtn", "description": [], + "signature": [ + "() => void" + ], "source": { "path": "x-pack/plugins/file_upload/public/lazy_load_bundle/index.ts", "lineNumber": 28 }, - "signature": [ - "() => void" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "fileUpload", "id": "def-public.FileUploadComponentProps.onUploadComplete", "type": "Function", + "tags": [], "label": "onUploadComplete", "description": [], - "source": { - "path": "x-pack/plugins/file_upload/public/lazy_load_bundle/index.ts", - "lineNumber": 29 - }, "signature": [ "(results: ", { @@ -169,68 +192,78 @@ "text": "FileUploadGeoResults" }, ") => void" - ] + ], + "source": { + "path": "x-pack/plugins/file_upload/public/lazy_load_bundle/index.ts", + "lineNumber": 29 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "fileUpload", "id": "def-public.FileUploadComponentProps.onUploadError", "type": "Function", + "tags": [], "label": "onUploadError", "description": [], + "signature": [ + "() => void" + ], "source": { "path": "x-pack/plugins/file_upload/public/lazy_load_bundle/index.ts", "lineNumber": 30 }, - "signature": [ - "() => void" - ] + "deprecated": false } ], - "source": { - "path": "x-pack/plugins/file_upload/public/lazy_load_bundle/index.ts", - "lineNumber": 23 - }, "initialIsOpen": false }, { + "parentPluginId": "fileUpload", "id": "def-public.FileUploadGeoResults", "type": "Interface", + "tags": [], "label": "FileUploadGeoResults", "description": [], - "tags": [], + "source": { + "path": "x-pack/plugins/file_upload/public/lazy_load_bundle/index.ts", + "lineNumber": 16 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "fileUpload", "id": "def-public.FileUploadGeoResults.indexPatternId", "type": "string", + "tags": [], "label": "indexPatternId", "description": [], "source": { "path": "x-pack/plugins/file_upload/public/lazy_load_bundle/index.ts", "lineNumber": 17 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "fileUpload", "id": "def-public.FileUploadGeoResults.geoFieldName", "type": "string", + "tags": [], "label": "geoFieldName", "description": [], "source": { "path": "x-pack/plugins/file_upload/public/lazy_load_bundle/index.ts", "lineNumber": 18 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "fileUpload", "id": "def-public.FileUploadGeoResults.geoFieldType", "type": "CompoundType", + "tags": [], "label": "geoFieldType", "description": [], - "source": { - "path": "x-pack/plugins/file_upload/public/lazy_load_bundle/index.ts", - "lineNumber": 19 - }, "signature": [ { "pluginId": "data", @@ -248,68 +281,85 @@ "text": "ES_FIELD_TYPES" }, ".GEO_SHAPE" - ] + ], + "source": { + "path": "x-pack/plugins/file_upload/public/lazy_load_bundle/index.ts", + "lineNumber": 19 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "fileUpload", "id": "def-public.FileUploadGeoResults.docCount", "type": "number", + "tags": [], "label": "docCount", "description": [], "source": { "path": "x-pack/plugins/file_upload/public/lazy_load_bundle/index.ts", "lineNumber": 20 - } + }, + "deprecated": false } ], - "source": { - "path": "x-pack/plugins/file_upload/public/lazy_load_bundle/index.ts", - "lineNumber": 16 - }, "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: ", { @@ -345,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", @@ -375,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", @@ -395,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", @@ -415,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<", { @@ -444,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", @@ -542,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", @@ -562,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", @@ -582,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", @@ -644,43 +730,49 @@ "section": "def-public.ImportConfig", "text": "ImportConfig" } - ] - } - ], - "source": { - "path": "x-pack/plugins/file_upload/public/importer/types.ts", - "lineNumber": 37 - }, + ], + "source": { + "path": "x-pack/plugins/file_upload/public/importer/types.ts", + "lineNumber": 40 + }, + "deprecated": false + } + ], "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", @@ -690,122 +782,139 @@ "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 }, { + "parentPluginId": "fileUpload", "id": "def-public.Props", "type": "Interface", + "tags": [], "label": "Props", "description": [], - "tags": [], + "source": { + "path": "x-pack/plugins/file_upload/public/components/geojson_upload_form/index_name_form.tsx", + "lineNumber": 14 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "fileUpload", "id": "def-public.Props.indexName", "type": "string", + "tags": [], "label": "indexName", "description": [], "source": { "path": "x-pack/plugins/file_upload/public/components/geojson_upload_form/index_name_form.tsx", "lineNumber": 15 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "fileUpload", "id": "def-public.Props.indexNameError", "type": "string", + "tags": [], "label": "indexNameError", "description": [], + "signature": [ + "string | undefined" + ], "source": { "path": "x-pack/plugins/file_upload/public/components/geojson_upload_form/index_name_form.tsx", "lineNumber": 16 }, - "signature": [ - "string | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "fileUpload", "id": "def-public.Props.onIndexNameChange", "type": "Function", + "tags": [], "label": "onIndexNameChange", "description": [], + "signature": [ + "(name: string, error?: string | undefined) => void" + ], "source": { "path": "x-pack/plugins/file_upload/public/components/geojson_upload_form/index_name_form.tsx", "lineNumber": 17 }, - "signature": [ - "(name: string, error?: string | undefined) => void" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "fileUpload", "id": "def-public.Props.onIndexNameValidationStart", "type": "Function", + "tags": [], "label": "onIndexNameValidationStart", "description": [], + "signature": [ + "() => void" + ], "source": { "path": "x-pack/plugins/file_upload/public/components/geojson_upload_form/index_name_form.tsx", "lineNumber": 18 }, - "signature": [ - "() => void" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "fileUpload", "id": "def-public.Props.onIndexNameValidationEnd", "type": "Function", + "tags": [], "label": "onIndexNameValidationEnd", "description": [], + "signature": [ + "() => void" + ], "source": { "path": "x-pack/plugins/file_upload/public/components/geojson_upload_form/index_name_form.tsx", "lineNumber": 19 }, - "signature": [ - "() => void" - ] + "deprecated": false } ], - "source": { - "path": "x-pack/plugins/file_upload/public/components/geojson_upload_form/index_name_form.tsx", - "lineNumber": 14 - }, "initialIsOpen": false } ], @@ -813,18 +922,20 @@ "misc": [], "objects": [], "start": { + "parentPluginId": "fileUpload", "id": "def-public.FileUploadPluginStart", "type": "Type", - "label": "FileUploadPluginStart", "tags": [], + "label": "FileUploadPluginStart", "description": [], + "signature": [ + "FileUploadStartApi" + ], "source": { "path": "x-pack/plugins/file_upload/public/plugin.ts", "lineNumber": 30 }, - "signature": [ - "FileUploadStartApi" - ], + "deprecated": false, "lifecycle": "start", "initialIsOpen": true } @@ -842,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": 22 - }, "signature": [ { "pluginId": "fileUpload", @@ -866,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": 23 - }, "signature": [ { "pluginId": "fileUpload", @@ -887,176 +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": 21 - }, "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": 118 - } + }, + "deprecated": false } ], - "source": { - "path": "x-pack/plugins/file_upload/common/types.ts", - "lineNumber": 117 - }, "initialIsOpen": false }, { + "parentPluginId": "fileUpload", "id": "def-common.FindFileStructureErrorResponse", "type": "Interface", + "tags": [], "label": "FindFileStructureErrorResponse", "description": [], - "tags": [], + "source": { + "path": "x-pack/plugins/file_upload/common/types.ts", + "lineNumber": 74 + }, + "deprecated": false, "children": [ { - "tags": [], + "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 }, - "signature": [ - "{ statusCode: number; error: string; message: string; attributes?: ErrorAttribute | undefined; }" - ] + "deprecated": false }, { - "tags": [], + "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 } ], - "source": { - "path": "x-pack/plugins/file_upload/common/types.ts", - "lineNumber": 74 - }, "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": 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": 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": 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": 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": 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": 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": 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": 46 - }, "signature": [ "{ properties: { [fieldName: string]: { type: ", { @@ -1098,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": 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": 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": 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": 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": 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": 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": 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": 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": 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": 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": 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": 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": 71 }, - "signature": [ - "boolean | undefined" - ] + "deprecated": false } ], - "source": { - "path": "x-pack/plugins/file_upload/common/types.ts", - "lineNumber": 26 - }, "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": 93 - } + }, + "deprecated": false } ], - "source": { - "path": "x-pack/plugins/file_upload/common/types.ts", - "lineNumber": 92 - }, "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": 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": 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": 114 - }, "signature": [ { "pluginId": "fileUpload", @@ -1349,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": 111 - }, "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": 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": 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": 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": 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": 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": 104 - }, "signature": [ { "pluginId": "fileUpload", @@ -1445,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": 105 - }, "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": 108 }, - "signature": [ - "boolean | undefined" - ] + "deprecated": false } ], - "source": { - "path": "x-pack/plugins/file_upload/common/types.ts", - "lineNumber": 98 - }, "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": 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": 146 }, - "signature": [ - "any[]" - ] + "deprecated": false } ], - "source": { - "path": "x-pack/plugins/file_upload/common/types.ts", - "lineNumber": 144 - }, "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": 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": 141 - }, "signature": [ { "pluginId": "fileUpload", @@ -1559,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": 139 - }, "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": 12 }, - "signature": [ - "any" - ] + "deprecated": false } ], - "source": { - "path": "x-pack/plugins/file_upload/common/types.ts", - "lineNumber": 11 - }, "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": 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": 134 }, - "signature": [ - "{ [key: string]: any; }" - ] + "deprecated": false } ], - "source": { - "path": "x-pack/plugins/file_upload/common/types.ts", - "lineNumber": 130 - }, "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": 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": 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": 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": 127 }, - "signature": [ - "any" - ] + "deprecated": false } ], - "source": { - "path": "x-pack/plugins/file_upload/common/types.ts", - "lineNumber": 123 - }, "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": [], + "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 }, - "signature": [ - "InputOverrides & { column_names: string[]; has_header_row: boolean; should_trim_fields: boolean; }" - ], + "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": 121 - }, "signature": [ "string | object | ", { @@ -1773,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": [ - "\"file-data-visualizer\"" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "fileUpload", "id": "def-common.InputData", "type": "Type", - "label": "InputData", "tags": [], + "label": "InputData", "description": [], + "signature": [ + "any[]" + ], "source": { "path": "x-pack/plugins/file_upload/common/types.ts", "lineNumber": 96 }, - "signature": [ - "any[]" - ], + "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/fleet.json b/api_docs/fleet.json index e525daefe2f41..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": 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": 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": 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": 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": 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": 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": 57 - }, "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": 58 - }, "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": 50 - }, "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 } ], + "returnComment": [] + }, + { + "parentPluginId": "fleet", + "id": "def-public.pagePathGetters.integration_details_policies", + "type": "Function", + "tags": [], + "label": "integration_details_policies", + "description": [], "signature": [ "({ pkgkey }: ", "DynamicPagePathValues", ") => string" ], - "description": [], - "label": "integration_details_overview", "source": { "path": "x-pack/plugins/fleet/public/applications/fleet/constants/page_paths.ts", - "lineNumber": 80 + "lineNumber": 81 }, - "tags": [], - "returnComment": [] - }, - { - "id": "def-public.pagePathGetters.integration_details_policies", - "type": "Function", + "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": 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": 57 - }, "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": 58 }, - "signature": [ - "() => Promise" - ] + "deprecated": false } ], - "source": { - "path": "x-pack/plugins/fleet/public/plugin.ts", - "lineNumber": 56 - }, "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": 92 - }, "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": 93 - }, "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": 94 - }, "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": 95 - }, "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": 96 - }, "signature": [ { "pluginId": "cloud", @@ -2466,18 +2753,20 @@ "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": [], - "source": { - "path": "x-pack/plugins/fleet/server/plugin.ts", - "lineNumber": 97 - }, "signature": [ { "pluginId": "usageCollection", @@ -2487,28 +2776,38 @@ "text": "UsageCollectionSetup" }, " | undefined" - ] + ], + "source": { + "path": "x-pack/plugins/fleet/server/plugin.ts", + "lineNumber": 97 + }, + "deprecated": false } ], - "source": { - "path": "x-pack/plugins/fleet/server/plugin.ts", - "lineNumber": 91 - }, "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<", { @@ -2528,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<", { @@ -2546,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": 137 - }, "signature": [ "[\"packagePolicyCreate\", (newPackagePolicy: ", { @@ -2638,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": [], + "signature": [ + "any" + ], "source": { "path": "x-pack/plugins/fleet/server/index.ts", "lineNumber": 66 }, - "signature": [ - "any" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "fleet", "id": "def-server.PackagePolicyServiceInterface", "type": "Type", - "label": "PackagePolicyServiceInterface", "tags": [], + "label": "PackagePolicyServiceInterface", "description": [], + "signature": [ + "PackagePolicyService" + ], "source": { "path": "x-pack/plugins/fleet/server/services/package_policy.ts", "lineNumber": 648 }, - "signature": [ - "PackagePolicyService" - ], + "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": [], + "signature": [ + "void" + ], "source": { "path": "x-pack/plugins/fleet/server/plugin.ts", "lineNumber": 122 }, - "signature": [ - "void" - ], + "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": 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": 167 - }, "signature": [ { "pluginId": "fleet", @@ -2747,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": 168 - }, "signature": [ { "pluginId": "fleet", @@ -2767,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": 169 - }, "signature": [ { "pluginId": "fleet", @@ -2787,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": 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": 174 - }, "signature": [ { "pluginId": "fleet", @@ -2823,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": 179 - }, "signature": [ "(...args: ", { @@ -2847,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" ], + "signature": [ + "(packageName: string) => ", + "FleetArtifactsClient" + ], "source": { "path": "x-pack/plugins/fleet/server/plugin.ts", "lineNumber": 185 }, - "signature": [ - "(packageName: string) => ", - "FleetArtifactsClient" - ] + "deprecated": false } ], - "source": { - "path": "x-pack/plugins/fleet/server/plugin.ts", - "lineNumber": 160 - }, "lifecycle": "start", "initialIsOpen": true } @@ -2878,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", @@ -2895,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", @@ -2967,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", @@ -3067,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": [], + "signature": [ + "(o: T) => [keyof T, T[keyof T]][]" + ], "source": { "path": "x-pack/plugins/fleet/common/types/index.ts", "lineNumber": 44 }, - "signature": [ - "(o: T) => [keyof T, T[keyof T]][]" - ], + "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", @@ -3142,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: ", { @@ -3185,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", @@ -3201,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", @@ -3280,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 - } - } - ], - "tags": [], - "returnComment": [], - "source": { - "path": "x-pack/plugins/fleet/common/services/is_valid_namespace.ts", - "lineNumber": 13 - }, + }, + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [], "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", @@ -3358,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: ", { @@ -3444,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", @@ -3483,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", @@ -3538,48 +3981,26 @@ }, "[]" ], - "description": [], "source": { "path": "x-pack/plugins/fleet/common/services/package_policies_to_agent_inputs.ts", "lineNumber": 12 - } + }, + "deprecated": false, + "isRequired": true } ], - "signature": [ - "(packagePolicies: ", - { - "pluginId": "fleet", - "scope": "common", - "docId": "kibFleetPluginApi", - "section": "def-common.PackagePolicy", - "text": "PackagePolicy" - }, - "[]) => ", - { - "pluginId": "fleet", - "scope": "common", - "docId": "kibFleetPluginApi", - "section": "def-common.FullAgentPolicyInput", - "text": "FullAgentPolicyInput" - }, - "[]" - ], - "description": [], - "label": "storedPackagePoliciesToAgentInputs", - "source": { - "path": "x-pack/plugins/fleet/common/services/package_policies_to_agent_inputs.ts", - "lineNumber": 11 - }, - "tags": [], "returnComment": [], "initialIsOpen": false } ], "interfaces": [ { + "parentPluginId": "fleet", "id": "def-common.Agent", "type": "Interface", + "tags": [], "label": "Agent", + "description": [], "signature": [ { "pluginId": "fleet", @@ -3590,73 +4011,83 @@ }, " extends AgentBase" ], - "description": [], - "tags": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/agent.ts", + "lineNumber": 118 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.Agent.id", "type": "string", + "tags": [], "label": "id", "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/agent.ts", "lineNumber": 119 - } + }, + "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": 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": 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": 122 }, - "signature": [ - "string[]" - ] + "deprecated": false } ], - "source": { - "path": "x-pack/plugins/fleet/common/types/models/agent.ts", - "lineNumber": 118 - }, "initialIsOpen": false }, { + "parentPluginId": "fleet", "id": "def-common.AgentAction", "type": "Interface", + "tags": [], "label": "AgentAction", + "description": [], "signature": [ { "pluginId": "fleet", @@ -3674,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", @@ -3695,122 +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 }, { + "parentPluginId": "fleet", "id": "def-common.AgentMetadata", "type": "Interface", + "tags": [], "label": "AgentMetadata", "description": [], - "tags": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/agent.ts", + "lineNumber": 96 + }, + "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": 97 }, - "signature": [ - "any" - ] + "deprecated": false } ], - "source": { - "path": "x-pack/plugins/fleet/common/types/models/agent.ts", - "lineNumber": 96 - }, "initialIsOpen": false }, { + "parentPluginId": "fleet", "id": "def-common.AgentPolicy", "type": "Interface", + "tags": [], "label": "AgentPolicy", + "description": [], "signature": [ { "pluginId": "fleet", @@ -3828,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", @@ -3861,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[] | ", { @@ -3883,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", @@ -3957,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", @@ -3989,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: ", { @@ -4011,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", @@ -4081,72 +4564,80 @@ }, " extends AgentBase" ], - "description": [], - "tags": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/agent.ts", + "lineNumber": 125 + }, + "deprecated": false, "children": [ { - "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": 126 }, - "signature": [ - "string[] | undefined" - ] + "deprecated": false } ], - "source": { - "path": "x-pack/plugins/fleet/common/types/models/agent.ts", - "lineNumber": 125 - }, "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": 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": 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": 224 - }, "signature": [ { "pluginId": "fleet", @@ -4155,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": 225 - }, "signature": [ { "pluginId": "fleet", @@ -4175,121 +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": 226 - } + }, + "deprecated": false } ], - "source": { - "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 221 - }, "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 }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.BaseSettings.has_seen_fleet_migration_notice", "type": "CompoundType", + "tags": [], "label": "has_seen_fleet_migration_notice", "description": [], + "signature": [ + "boolean | undefined" + ], "source": { "path": "x-pack/plugins/fleet/common/types/models/settings.ts", "lineNumber": 12 }, - "signature": [ - "boolean | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.BaseSettings.fleet_server_hosts", "type": "Array", + "tags": [], "label": "fleet_server_hosts", "description": [], + "signature": [ + "string[]" + ], "source": { "path": "x-pack/plugins/fleet/common/types/models/settings.ts", "lineNumber": 13 }, - "signature": [ - "string[]" - ] + "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": 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": 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": 96 - }, "signature": [ { "pluginId": "fleet", @@ -4298,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": 93 - }, "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": 104 }, - "signature": [ - "{ packages: string[]; }" - ] + "deprecated": false } ], - "source": { - "path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts", - "lineNumber": 103 - }, "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": 100 - }, "signature": [ "(", { @@ -4370,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": 99 - }, "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": 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": 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": 217 - } + }, + "deprecated": false } ], - "source": { - "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 214 - }, "initialIsOpen": false }, { + "parentPluginId": "fleet", "id": "def-common.CheckPermissionsResponse", "type": "Interface", + "tags": [], "label": "CheckPermissionsResponse", "description": [], - "tags": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/rest_spec/app.ts", + "lineNumber": 8 + }, + "deprecated": false, "children": [ { - "tags": [], + "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<", { @@ -4492,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", @@ -4526,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", @@ -4560,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", @@ -4594,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", @@ -4653,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", @@ -4687,148 +5248,172 @@ "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 }, { + "parentPluginId": "fleet", "id": "def-common.DefaultPackagesInstallationError", "type": "Interface", + "tags": [], "label": "DefaultPackagesInstallationError", "description": [], - "tags": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/epm.ts", + "lineNumber": 33 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.DefaultPackagesInstallationError.installType", "type": "CompoundType", + "tags": [], "label": "installType", "description": [], - "source": { - "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 34 - }, "signature": [ { "pluginId": "fleet", @@ -4837,247 +5422,283 @@ "section": "def-common.InstallType", "text": "InstallType" } - ] + ], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/epm.ts", + "lineNumber": 34 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.DefaultPackagesInstallationError.error", "type": "Object", + "tags": [], "label": "error", "description": [], + "signature": [ + "Error" + ], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", "lineNumber": 35 }, - "signature": [ - "Error" - ] + "deprecated": false } ], - "source": { - "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 33 - }, "initialIsOpen": false }, { + "parentPluginId": "fleet", "id": "def-common.DeleteAgentPolicyRequest", "type": "Interface", + "tags": [], "label": "DeleteAgentPolicyRequest", "description": [], - "tags": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/rest_spec/agent_policy.ts", + "lineNumber": 61 + }, + "deprecated": false, "children": [ { - "tags": [], + "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 }, - "signature": [ - "{ agentPolicyId: string; }" - ] + "deprecated": false } ], - "source": { - "path": "x-pack/plugins/fleet/common/types/rest_spec/agent_policy.ts", - "lineNumber": 61 - }, "initialIsOpen": false }, { + "parentPluginId": "fleet", "id": "def-common.DeleteAgentPolicyResponse", "type": "Interface", + "tags": [], "label": "DeleteAgentPolicyResponse", "description": [], - "tags": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/rest_spec/agent_policy.ts", + "lineNumber": 67 + }, + "deprecated": false, "children": [ { - "tags": [], + "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": 135 }, - "signature": [ - "{ agentId: string; }" - ] + "deprecated": false } ], - "source": { - "path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts", - "lineNumber": 134 - }, "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": 114 }, - "signature": [ - "{ pkgkey: string; }" - ] + "deprecated": false } ], - "source": { - "path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts", - "lineNumber": 113 - }, "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": 120 - }, "signature": [ { "pluginId": "fleet", @@ -5087,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": 119 - }, "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": 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": 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": 323 - }, "signature": [ { "pluginId": "fleet", @@ -5240,99 +5885,113 @@ "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": 324 }, - "signature": [ - "boolean | undefined" - ] + "deprecated": false } ], - "source": { - "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 320 - }, "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": 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": 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": 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": 16 }, - "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; }" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.FleetConfigType.agentPolicies", "type": "Array", + "tags": [], "label": "agentPolicies", "description": [], - "source": { - "path": "x-pack/plugins/fleet/common/types/index.ts", - "lineNumber": 35 - }, "signature": [ { "pluginId": "fleet", @@ -5342,18 +6001,20 @@ "text": "PreconfiguredAgentPolicy" }, "[] | undefined" - ] + ], + "source": { + "path": "x-pack/plugins/fleet/common/types/index.ts", + "lineNumber": 35 + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.FleetConfigType.packages", "type": "Array", + "tags": [], "label": "packages", "description": [], - "source": { - "path": "x-pack/plugins/fleet/common/types/index.ts", - "lineNumber": 36 - }, "signature": [ "Pick<", { @@ -5364,68 +6025,76 @@ "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": 12 - }, "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": 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": 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": 146 - }, "signature": [ { "pluginId": "fleet", @@ -5434,12 +6103,18 @@ "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" @@ -5447,12 +6122,14 @@ "source": { "path": "x-pack/plugins/fleet/common/types/models/agent.ts", "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" @@ -5460,98 +6137,106 @@ "source": { "path": "x-pack/plugins/fleet/common/types/models/agent.ts", "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": 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": 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": 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": 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": 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": 175 - }, "signature": [ { "pluginId": "fleet", @@ -5561,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": 179 - }, "signature": [ { "pluginId": "fleet", @@ -5583,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": 183 - }, "signature": [ { "pluginId": "fleet", @@ -5605,378 +6294,430 @@ "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": 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": 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": 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": 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": 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": 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": 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": 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": 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": 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": 227 }, - "signature": [ - "number | undefined" - ] + "deprecated": false } ], - "source": { - "path": "x-pack/plugins/fleet/common/types/models/agent.ts", - "lineNumber": 134 - }, "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": 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": 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": 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": 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": 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": 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": 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": 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": 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": 286 }, - "signature": [ - "any" - ] + "deprecated": false } ], - "source": { - "path": "x-pack/plugins/fleet/common/types/models/agent.ts", - "lineNumber": 247 - }, "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" @@ -5984,12 +6725,14 @@ "source": { "path": "x-pack/plugins/fleet/common/types/models/agent.ts", "lineNumber": 236 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.FleetServerAgentMetadata.version", "type": "string", + "tags": [], "label": "version", "description": [ "\nThe version of the Elastic Agent" @@ -5997,58 +6740,66 @@ "source": { "path": "x-pack/plugins/fleet/common/types/models/agent.ts", "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": 241 }, - "signature": [ - "any" - ] + "deprecated": false } ], - "source": { - "path": "x-pack/plugins/fleet/common/types/models/agent.ts", - "lineNumber": 232 - }, "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" @@ -6056,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" @@ -6069,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" @@ -6186,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" @@ -6199,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" @@ -6212,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" @@ -6241,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<", { @@ -6288,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]: ", { @@ -6310,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: ", { @@ -6332,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", @@ -6353,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<", { @@ -6486,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", @@ -6507,216 +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 } ], - "source": { - "path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts", - "lineNumber": 63 - }, "initialIsOpen": false }, { + "parentPluginId": "fleet", "id": "def-common.GenerateServiceTokenResponse", "type": "Interface", + "tags": [], "label": "GenerateServiceTokenResponse", "description": [], - "tags": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/rest_spec/app.ts", + "lineNumber": 13 + }, + "deprecated": false, "children": [ { - "tags": [], + "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 }, { - "tags": [], + "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 } ], - "source": { - "path": "x-pack/plugins/fleet/common/types/rest_spec/app.ts", - "lineNumber": 13 - }, "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", @@ -6726,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", @@ -6761,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": 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": 10 - }, "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": 21 - }, "signature": [ { "pluginId": "fleet", @@ -6857,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": 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": 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": 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": 25 - } + }, + "deprecated": false } ], - "source": { - "path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts", - "lineNumber": 20 - }, "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": 150 }, - "signature": [ - "{ kuery?: string | undefined; policyId?: string | undefined; }" - ] + "deprecated": false } ], - "source": { - "path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts", - "lineNumber": 149 - }, "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": 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": 156 - }, "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": 19 }, - "signature": [ - "{ experimental?: boolean | undefined; }" - ] + "deprecated": false } ], - "source": { - "path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts", - "lineNumber": 18 - }, "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": 25 - }, "signature": [ { "pluginId": "fleet", @@ -7019,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": 24 - }, "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", @@ -7054,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", @@ -7117,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": 44 }, - "signature": [ - "{ pkgkey: string; filePath: string; }" - ] + "deprecated": false } ], - "source": { - "path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts", - "lineNumber": 43 - }, "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": [ - "(\"fleet_server\" | \"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", @@ -7279,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": 51 }, - "signature": [ - "{ pkgkey: string; }" - ] + "deprecated": false } ], - "source": { - "path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts", - "lineNumber": 50 - }, "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": 57 - }, "signature": [ { "pluginId": "fleet", @@ -7341,88 +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": 56 - }, "initialIsOpen": false }, { + "parentPluginId": "fleet", "id": "def-common.GetLimitedPackagesResponse", "type": "Interface", + "tags": [], "label": "GetLimitedPackagesResponse", "description": [], - "tags": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts", + "lineNumber": 39 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.GetLimitedPackagesResponse.response", "type": "Array", + "tags": [], "label": "response", "description": [], + "signature": [ + "string[]" + ], "source": { "path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts", "lineNumber": 40 }, - "signature": [ - "string[]" - ] + "deprecated": false } ], - "source": { - "path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts", - "lineNumber": 39 - }, "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", @@ -7431,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": 29 }, - "signature": [ - "{ agentId: string; }" - ] + "deprecated": false } ], - "source": { - "path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts", - "lineNumber": 28 - }, "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": 35 - }, "signature": [ { "pluginId": "fleet", @@ -7493,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": 34 - }, "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", @@ -7555,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", @@ -7617,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", @@ -7679,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", @@ -7714,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", @@ -7810,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": 29 }, - "signature": [ - "{ category?: string | undefined; experimental?: boolean | undefined; }" - ] + "deprecated": false } ], - "source": { - "path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts", - "lineNumber": 28 - }, "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": 36 - }, "signature": [ { "pluginId": "fleet", @@ -7914,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": 35 - }, "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", @@ -7948,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": 61 }, - "signature": [ - "{ pkgname: string; }" - ] + "deprecated": false } ], - "source": { - "path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts", - "lineNumber": 60 - }, "initialIsOpen": false }, { + "parentPluginId": "fleet", "id": "def-common.GetStatsResponse", "type": "Interface", + "tags": [], "label": "GetStatsResponse", "description": [], - "tags": [], + "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": 67 - }, "signature": [ { "pluginId": "fleet", @@ -8010,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": 66 - }, "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": 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": 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": 83 }, - "signature": [ - "string | Error" - ] + "deprecated": false } ], - "source": { - "path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts", - "lineNumber": 80 - }, "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": 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": 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": 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": 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": 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": 400 }, - "signature": [ - "object" - ] + "deprecated": false } ], - "source": { - "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 391 - }, "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": 385 }, - "signature": [ - "any" - ] + "deprecated": false } ], - "source": { - "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 384 - }, "initialIsOpen": false }, { + "parentPluginId": "fleet", "id": "def-common.Installation", "type": "Interface", + "tags": [], "label": "Installation", + "description": [], "signature": [ { "pluginId": "fleet", @@ -8207,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": 340 - }, "signature": [ { "pluginId": "fleet", @@ -8229,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": 341 - }, "signature": [ { "pluginId": "fleet", @@ -8250,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": 342 - }, "signature": [ { "pluginId": "fleet", @@ -8271,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": 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": 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": 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": 346 - }, "signature": [ { "pluginId": "fleet", @@ -8327,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": 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": 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": 349 - }, "signature": [ { "pluginId": "fleet", @@ -8369,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": 339 - }, "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": 71 }, - "signature": [ - "{ pkgkey: string; }" - ] + "deprecated": false } ], - "source": { - "path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts", - "lineNumber": 70 - }, "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": 77 - }, "signature": [ { "pluginId": "fleet", @@ -8432,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": 76 - }, "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": 87 - }, "signature": [ { "pluginId": "fleet", @@ -8467,46 +9540,52 @@ "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": 88 }, - "signature": [ - "\"installed\" | \"already_installed\" | undefined" - ] + "deprecated": false }, { - "tags": [], + "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 }, - "signature": [ - "Error | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.InstallResult.installType", "type": "CompoundType", + "tags": [], "label": "installType", "description": [], - "source": { - "path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts", - "lineNumber": 90 - }, "signature": [ { "pluginId": "fleet", @@ -8515,47 +9594,55 @@ "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": 86 - }, "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", @@ -8566,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", @@ -8644,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": 110 - } + }, + "deprecated": false } ], - "source": { - "path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts", - "lineNumber": 109 - }, "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", @@ -8774,369 +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 }, { + "parentPluginId": "fleet", "id": "def-common.NewAgentPolicy", "type": "Interface", + "tags": [], "label": "NewAgentPolicy", "description": [], - "tags": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts", + "lineNumber": 16 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.NewAgentPolicy.name", "type": "string", + "tags": [], "label": "name", "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts", "lineNumber": 17 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.NewAgentPolicy.namespace", "type": "string", + "tags": [], "label": "namespace", "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts", "lineNumber": 18 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.NewAgentPolicy.description", "type": "string", + "tags": [], "label": "description", "description": [], + "signature": [ + "string | undefined" + ], "source": { "path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts", "lineNumber": 19 }, - "signature": [ - "string | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.NewAgentPolicy.is_default", "type": "CompoundType", + "tags": [], "label": "is_default", "description": [], + "signature": [ + "boolean | undefined" + ], "source": { "path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts", "lineNumber": 20 }, - "signature": [ - "boolean | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.NewAgentPolicy.is_default_fleet_server", "type": "CompoundType", + "tags": [], "label": "is_default_fleet_server", "description": [], + "signature": [ + "boolean | undefined" + ], "source": { "path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts", "lineNumber": 21 }, - "signature": [ - "boolean | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.NewAgentPolicy.is_managed", "type": "CompoundType", + "tags": [], "label": "is_managed", "description": [], + "signature": [ + "boolean | undefined" + ], "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 }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.NewAgentPolicy.is_preconfigured", "type": "CompoundType", + "tags": [], "label": "is_preconfigured", "description": [], + "signature": [ + "boolean | undefined" + ], "source": { "path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts", "lineNumber": 24 }, - "signature": [ - "boolean | 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", + "tags": [], "label": "api_key", "description": [], + "signature": [ + "string | undefined" + ], "source": { "path": "x-pack/plugins/fleet/common/types/models/output.ts", "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": 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": 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": 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": 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": 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": 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": 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": 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": 57 - }, "signature": [ { "pluginId": "fleet", @@ -9146,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": 58 - }, "signature": [ { "pluginId": "fleet", @@ -9167,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": 50 - }, "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": 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": 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": 40 - }, "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": 41 - }, "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": 42 - }, "signature": [ { "pluginId": "fleet", @@ -9268,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": 37 - }, "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": 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": 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": 28 - }, "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": 29 - }, "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": 22 - }, "initialIsOpen": false }, { + "parentPluginId": "fleet", "id": "def-common.PackagePolicy", "type": "Interface", + "tags": [], "label": "PackagePolicy", + "description": [], "signature": [ { "pluginId": "fleet", @@ -9382,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": 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": 67 - }, "signature": [ { "pluginId": "fleet", @@ -9415,144 +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": 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": 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": 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": 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": 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": 73 - } + }, + "deprecated": false } ], - "source": { - "path": "x-pack/plugins/fleet/common/types/models/package_policy.ts", - "lineNumber": 65 - }, "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 }, - "signature": [ - "any" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.PackagePolicyConfigRecordEntry.frozen", "type": "CompoundType", + "tags": [], "label": "frozen", "description": [], + "signature": [ + "boolean | undefined" + ], "source": { "path": "x-pack/plugins/fleet/common/types/models/package_policy.ts", "lineNumber": 17 }, - "signature": [ - "boolean | undefined" - ] + "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", @@ -9571,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": 46 - }, "signature": [ { "pluginId": "fleet", @@ -9593,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": 47 }, - "signature": [ - "any" - ] + "deprecated": false } ], - "source": { - "path": "x-pack/plugins/fleet/common/types/models/package_policy.ts", - "lineNumber": 45 - }, "initialIsOpen": false }, { + "parentPluginId": "fleet", "id": "def-common.PackagePolicyInputStream", "type": "Interface", + "tags": [], "label": "PackagePolicyInputStream", + "description": [], "signature": [ { "pluginId": "fleet", @@ -9637,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": 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": 34 }, - "signature": [ - "any" - ] + "deprecated": false } ], - "source": { - "path": "x-pack/plugins/fleet/common/types/models/package_policy.ts", - "lineNumber": 32 - }, "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\" | \"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" - ] + "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", @@ -9937,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", @@ -9958,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", @@ -9979,368 +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": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/package_spec.ts", + "lineNumber": 67 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.PackageSpecScreenshot.src", "type": "string", + "tags": [], "label": "src", "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/package_spec.ts", "lineNumber": 68 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.PackageSpecScreenshot.title", "type": "string", + "tags": [], "label": "title", "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/package_spec.ts", "lineNumber": 69 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.PackageSpecScreenshot.size", "type": "string", + "tags": [], "label": "size", "description": [], + "signature": [ + "string | undefined" + ], "source": { "path": "x-pack/plugins/fleet/common/types/models/package_spec.ts", "lineNumber": 70 }, - "signature": [ - "string | undefined" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.PackageSpecScreenshot.type", "type": "string", + "tags": [], "label": "type", "description": [], + "signature": [ + "string | undefined" + ], "source": { "path": "x-pack/plugins/fleet/common/types/models/package_spec.ts", "lineNumber": 71 }, - "signature": [ - "string | undefined" - ] + "deprecated": false } ], - "source": { - "path": "x-pack/plugins/fleet/common/types/models/package_spec.ts", - "lineNumber": 67 - }, "initialIsOpen": false }, { + "parentPluginId": "fleet", "id": "def-common.PackageUsageStats", "type": "Interface", + "tags": [], "label": "PackageUsageStats", "description": [], - "tags": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/epm.ts", + "lineNumber": 352 + }, + "deprecated": false, "children": [ { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.PackageUsageStats.agent_policy_count", "type": "number", + "tags": [], "label": "agent_policy_count", "description": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", "lineNumber": 353 - } + }, + "deprecated": false } ], - "source": { - "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 352 - }, "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": 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": 55 }, - "signature": [ - "{ force?: boolean | undefined; revoke?: boolean | undefined; }" - ] + "deprecated": false } ], - "source": { - "path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts", - "lineNumber": 51 - }, "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": 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": 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": 84 }, - "signature": [ - "{ source_uri?: string | undefined; version: string; }" - ] + "deprecated": false } ], - "source": { - "path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts", - "lineNumber": 80 - }, "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": 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": 120 }, - "signature": [ - "{ policy_id: string; agents: string | string[]; }" - ] + "deprecated": false } ], - "source": { - "path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts", - "lineNumber": 119 - }, "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": 65 }, - "signature": [ - "{ agents: string | string[]; force?: boolean | undefined; revoke?: boolean | undefined; }" - ] + "deprecated": false } ], - "source": { - "path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts", - "lineNumber": 64 - }, "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": 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": 90 - }, "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", @@ -10349,71 +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 - } + }, + "deprecated": false }, { - "tags": [], + "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 }, - "signature": [ - "{ error: Error; }[] | undefined" - ] + "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": 39 - }, "signature": [ "{ action: ", { @@ -10424,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": 42 }, - "signature": [ - "{ agentId: string; }" - ] + "deprecated": false } ], - "source": { - "path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts", - "lineNumber": 38 - }, "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": 48 - }, "signature": [ { "pluginId": "fleet", @@ -10472,75 +11819,87 @@ "section": "def-common.AgentAction", "text": "AgentAction" } - ] + ], + "source": { + "path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts", + "lineNumber": 48 + }, + "deprecated": false } ], - "source": { - "path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts", - "lineNumber": 47 - }, "initialIsOpen": false }, { + "parentPluginId": "fleet", "id": "def-common.PreconfigurationError", "type": "Interface", + "tags": [], "label": "PreconfigurationError", "description": [], - "tags": [], + "source": { + "path": "x-pack/plugins/fleet/common/constants/preconfiguration.ts", + "lineNumber": 67 + }, + "deprecated": false, "children": [ { - "tags": [], + "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 }, - "signature": [ - "{ name: string; version: string; } | undefined" - ] + "deprecated": false }, { - "tags": [], + "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 }, - "signature": [ - "{ name: string; } | undefined" - ] + "deprecated": false }, { - "tags": [], + "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 }, - "signature": [ - "Error" - ] + "deprecated": false } ], - "source": { - "path": "x-pack/plugins/fleet/common/constants/preconfiguration.ts", - "lineNumber": 67 - }, "initialIsOpen": false }, { + "parentPluginId": "fleet", "id": "def-common.PreconfiguredAgentPolicy", "type": "Interface", + "tags": [], "label": "PreconfiguredAgentPolicy", + "description": [], "signature": [ { "pluginId": "fleet", @@ -10559,47 +11918,51 @@ }, ", \"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 | 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", @@ -10757,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>" - ] + ], + "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", @@ -10827,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": 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": 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": 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": 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": 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": 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": 273 - }, "signature": [ { "pluginId": "fleet", @@ -10934,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": 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": 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": 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": 277 - }, "signature": [ { "pluginId": "fleet", @@ -10988,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": 278 }, - "signature": [ - "boolean | undefined" - ] + "deprecated": false } ], - "source": { - "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 266 - }, "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": 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": 283 }, - "signature": [ - "object | undefined" - ] + "deprecated": false } ], - "source": { - "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 281 - }, "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": 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": 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": 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": 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": 126 }, - "signature": [ - "string | undefined" - ] + "deprecated": false } ], - "source": { - "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 121 - }, "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": 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": 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": 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": 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": 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": 160 - }, "signature": [ { "pluginId": "fleet", @@ -11218,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": 154 - }, "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": 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": 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": 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": 141 - }, "signature": [ { "pluginId": "fleet", @@ -11286,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": 142 }, - "signature": [ - "boolean | undefined" - ] + "deprecated": false } ], - "source": { - "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 137 - }, "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": 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": 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": 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": 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": 177 - }, "signature": [ { "pluginId": "fleet", @@ -11385,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": 178 - } + }, + "deprecated": false } ], - "source": { - "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 172 - }, "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": 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": 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": 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": 306 - }, "signature": [ { "pluginId": "fleet", @@ -11469,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": 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": 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": 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": 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": 311 }, - "signature": [ - "{ [key: string]: { default: string | string[]; }; } | undefined" - ] + "deprecated": false } ], - "source": { - "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 302 - }, "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": 184 - } + }, + "deprecated": false } ], - "source": { - "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 183 - }, "initialIsOpen": false }, { + "parentPluginId": "fleet", "id": "def-common.Settings", "type": "Interface", + "tags": [], "label": "Settings", + "description": [], "signature": [ { "pluginId": "fleet", @@ -11594,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": 17 - } + }, + "deprecated": false } ], - "source": { - "path": "x-pack/plugins/fleet/common/types/models/settings.ts", - "lineNumber": 16 - }, "initialIsOpen": false }, { + "parentPluginId": "fleet", "id": "def-common.SettingsSOAttributes", "type": "Interface", + "tags": [], "label": "SettingsSOAttributes", + "description": [], "signature": [ { "pluginId": "fleet", @@ -11638,43 +13143,47 @@ ",", "SavedObjectAttributes" ], - "description": [], - "tags": [], - "children": [], "source": { "path": "x-pack/plugins/fleet/common/types/models/settings.ts", "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": 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": 405 - }, "signature": [ { "pluginId": "fleet", @@ -11683,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": 403 - }, "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", @@ -11717,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": 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": 144 }, - "signature": [ - "{ user_provided_metadata: Record; }" - ] + "deprecated": false } ], - "source": { - "path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts", - "lineNumber": 140 - }, "initialIsOpen": false }, { + "parentPluginId": "fleet", "id": "def-common.UpdatePackagePolicy", "type": "Interface", + "tags": [], "label": "UpdatePackagePolicy", + "description": [], "signature": [ { "pluginId": "fleet", @@ -11789,584 +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": 62 }, - "signature": [ - "string | undefined" - ] + "deprecated": false } ], - "source": { - "path": "x-pack/plugins/fleet/common/types/models/package_policy.ts", - "lineNumber": 61 - }, "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": 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": 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": 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": 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": 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": 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": 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": 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": [], + "signature": [ + "\"fleet-agent-actions\"" + ], "source": { "path": "x-pack/plugins/fleet/common/constants/agent.ts", "lineNumber": 9 }, - "signature": [ - "\"fleet-agent-actions\"" - ], + "deprecated": false, "initialIsOpen": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.AGENT_ACTIONS_INDEX", "type": "string", + "tags": [], "label": "AGENT_ACTIONS_INDEX", "description": [], + "signature": [ + "\".fleet-actions\"" + ], "source": { "path": "x-pack/plugins/fleet/common/constants/agent.ts", "lineNumber": 27 }, - "signature": [ - "\".fleet-actions\"" - ], + "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": [], + "signature": [ + "\".fleet-policies\"" + ], "source": { "path": "x-pack/plugins/fleet/common/constants/agent_policy.ts", "lineNumber": 9 }, - "signature": [ - "\".fleet-policies\"" - ], + "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": [], + "signature": [ + "1000" + ], "source": { "path": "x-pack/plugins/fleet/common/constants/agent.ts", "lineNumber": 23 }, - "signature": [ - "1000" - ], + "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": [], + "signature": [ + "5" + ], "source": { "path": "x-pack/plugins/fleet/common/constants/agent.ts", "lineNumber": 24 }, - "signature": [ - "5" - ], + "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": [], + "signature": [ + "\"ingest-agent-policies\"" + ], "source": { "path": "x-pack/plugins/fleet/common/constants/agent_policy.ts", "lineNumber": 8 }, - "signature": [ - "\"ingest-agent-policies\"" - ], + "deprecated": false, "initialIsOpen": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.AGENT_POLLING_INTERVAL", "type": "number", + "tags": [], "label": "AGENT_POLLING_INTERVAL", "description": [], + "signature": [ + "1000" + ], "source": { "path": "x-pack/plugins/fleet/common/constants/agent.ts", "lineNumber": 19 }, - "signature": [ - "1000" - ], + "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": [], + "signature": [ + "20000" + ], "source": { "path": "x-pack/plugins/fleet/common/constants/agent.ts", "lineNumber": 16 }, - "signature": [ - "20000" - ], + "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": [], + "signature": [ + "300000" + ], "source": { "path": "x-pack/plugins/fleet/common/constants/agent.ts", "lineNumber": 15 }, - "signature": [ - "300000" - ], + "deprecated": false, "initialIsOpen": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.AGENT_POLLING_THRESHOLD_MS", "type": "number", + "tags": [], "label": "AGENT_POLLING_THRESHOLD_MS", "description": [], + "signature": [ + "30000" + ], "source": { "path": "x-pack/plugins/fleet/common/constants/agent.ts", "lineNumber": 18 }, - "signature": [ - "30000" - ], + "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": [], + "signature": [ + "\"EPHEMERAL\"" + ], "source": { "path": "x-pack/plugins/fleet/common/constants/agent.ts", "lineNumber": 12 }, - "signature": [ - "\"EPHEMERAL\"" - ], + "deprecated": false, "initialIsOpen": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.AGENT_TYPE_PERMANENT", "type": "string", + "tags": [], "label": "AGENT_TYPE_PERMANENT", "description": [], + "signature": [ + "\"PERMANENT\"" + ], "source": { "path": "x-pack/plugins/fleet/common/constants/agent.ts", "lineNumber": 11 }, - "signature": [ - "\"PERMANENT\"" - ], + "deprecated": false, "initialIsOpen": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.AGENT_TYPE_TEMPORARY", "type": "string", + "tags": [], "label": "AGENT_TYPE_TEMPORARY", "description": [], + "signature": [ + "\"TEMPORARY\"" + ], "source": { "path": "x-pack/plugins/fleet/common/constants/agent.ts", "lineNumber": 13 }, - "signature": [ - "\"TEMPORARY\"" - ], + "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": [], + "signature": [ + "5000" + ], "source": { "path": "x-pack/plugins/fleet/common/constants/agent.ts", "lineNumber": 21 }, - "signature": [ - "5000" - ], + "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": [], + "signature": [ + "30000" + ], "source": { "path": "x-pack/plugins/fleet/common/constants/agent.ts", "lineNumber": 20 }, - "signature": [ - "30000" - ], + "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": [], + "signature": [ + "\"POLICY_CHANGE\" | \"UNENROLL\" | \"UPGRADE\" | \"SETTINGS\" | \"POLICY_REASSIGN\"" + ], "source": { "path": "x-pack/plugins/fleet/common/types/models/agent.ts", "lineNumber": 34 }, - "signature": [ - "\"POLICY_CHANGE\" | \"UNENROLL\" | \"UPGRADE\" | \"SETTINGS\" | \"POLICY_REASSIGN\"" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "fleet", "id": "def-common.AgentAssetType", "type": "Type", - "label": "AgentAssetType", "tags": [], + "label": "AgentAssetType", "description": [], + "signature": [ + "{ readonly Input: \"input\"; }" + ], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", "lineNumber": 45 }, - "signature": [ - "{ readonly Input: \"input\"; }" - ], + "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; 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; }" - ], + "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": [], + "signature": [ + "\".fleet-agents\"" + ], "source": { "path": "x-pack/plugins/fleet/common/constants/agent.ts", "lineNumber": 26 }, - "signature": [ - "\".fleet-agents\"" - ], + "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": [], + "signature": [ + "PackageSpecManifest & Pick" + ], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", "lineNumber": 89 }, - "signature": [ - "PackageSpecManifest & Pick" - ], + "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": 367 - }, "signature": [ { "pluginId": "fleet", @@ -12384,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": [], + "signature": [ + "Record<\"kibana\", Record> & Record<\"elasticsearch\", Record>" + ], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", "lineNumber": 229 }, - "signature": [ - "Record<\"kibana\", Record> & Record<\"elasticsearch\", Record>" - ], + "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": 46 - }, "signature": [ "\"input\" | ", { @@ -12468,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": [], + "signature": [ + "Record & Record" + ], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", "lineNumber": 228 }, - "signature": [ - "Record & Record" - ], + "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", @@ -12512,372 +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": [], + "signature": [ + "string" + ], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", "lineNumber": 213 }, - "signature": [ - "string" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "fleet", "id": "def-common.CategorySummaryList", "type": "Type", - "label": "CategorySummaryList", "tags": [], + "label": "CategorySummaryList", "description": [], + "signature": [ + "CategorySummaryItem[]" + ], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", "lineNumber": 212 }, - "signature": [ - "CategorySummaryItem[]" - ], + "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": [], + "signature": [ + "{ readonly Logs: \"logs\"; readonly Metrics: \"metrics\"; }" + ], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", "lineNumber": 85 }, - "signature": [ - "{ readonly Logs: \"logs\"; readonly Metrics: \"metrics\"; }" - ], + "deprecated": false, "initialIsOpen": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.DEFAULT_PACKAGES", "type": "Array", + "tags": [], "label": "DEFAULT_PACKAGES", "description": [], + "signature": [ + "{ name: \"endpoint\" | \"fleet_server\" | \"system\" | \"elastic_agent\"; version: string; }[]" + ], "source": { "path": "x-pack/plugins/fleet/common/constants/preconfiguration.ts", "lineNumber": 59 }, - "signature": [ - "{ name: \"endpoint\" | \"fleet_server\" | \"system\" | \"elastic_agent\"; version: string; }[]" - ], + "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": 382 }, - "signature": [ - "{ readonly System: \"system\"; readonly Endpoint: \"endpoint\"; readonly ElasticAgent: \"elastic_agent\"; readonly FleetServer: \"fleet_server\"; }" - ], + "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": [], + "signature": [ + "\"custom\" | \"settings\" | \"overview\" | \"policies\"" + ], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", "lineNumber": 43 }, - "signature": [ - "\"custom\" | \"settings\" | \"overview\" | \"policies\"" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "fleet", "id": "def-common.ElasticsearchAssetParts", "type": "Type", - "label": "ElasticsearchAssetParts", "tags": [], + "label": "ElasticsearchAssetParts", "description": [], + "signature": [ + "AssetParts & { service: Extract; type: ElasticsearchAssetType; }" + ], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", "lineNumber": 240 }, - "signature": [ - "AssetParts & { service: Extract; type: ElasticsearchAssetType; }" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "fleet", "id": "def-common.ElasticsearchAssetTypeToParts", "type": "Type", - "label": "ElasticsearchAssetTypeToParts", "tags": [], + "label": "ElasticsearchAssetTypeToParts", "description": [], + "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 }, - "signature": [ - "{ component_template: ElasticsearchAssetParts[]; ingest_pipeline: ElasticsearchAssetParts[]; index_template: ElasticsearchAssetParts[]; ilm_policy: ElasticsearchAssetParts[]; transform: ElasticsearchAssetParts[]; data_stream_ilm_policy: ElasticsearchAssetParts[]; }" - ], + "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; created_at: string; policy_id?: string | undefined; 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": [], + "signature": [ + "\"installed\" | \"installing\"" + ], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", "lineNumber": 41 }, - "signature": [ - "\"installed\" | \"installing\"" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "fleet", "id": "def-common.EsAssetReference", "type": "Type", - "label": "EsAssetReference", "tags": [], + "label": "EsAssetReference", "description": [], + "signature": [ + "Pick & { type: ElasticsearchAssetType; }" + ], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", "lineNumber": 372 }, - "signature": [ - "Pick & { type: ElasticsearchAssetType; }" - ], + "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": [], + "signature": [ + "\".fleet-artifacts\"" + ], "source": { "path": "x-pack/plugins/fleet/common/constants/index.ts", "lineNumber": 28 }, - "signature": [ - "\".fleet-artifacts\"" - ], + "deprecated": false, "initialIsOpen": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.FLEET_SERVER_INDICES", "type": "Array", + "tags": [], "label": "FLEET_SERVER_INDICES", "description": [], + "signature": [ + "string[]" + ], "source": { "path": "x-pack/plugins/fleet/common/constants/index.ts", "lineNumber": 32 }, - "signature": [ - "string[]" - ], + "deprecated": false, "initialIsOpen": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.FLEET_SERVER_INDICES_VERSION", "type": "number", + "tags": [], "label": "FLEET_SERVER_INDICES_VERSION", "description": [], + "signature": [ + "1" + ], "source": { "path": "x-pack/plugins/fleet/common/constants/index.ts", "lineNumber": 26 }, - "signature": [ - "1" - ], + "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 }, - "signature": [ - "\"fleet_server\"" - ], + "deprecated": false, "initialIsOpen": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.FLEET_SERVER_SERVERS_INDEX", "type": "string", + "tags": [], "label": "FLEET_SERVER_SERVERS_INDEX", "description": [], + "signature": [ + "\".fleet-servers\"" + ], "source": { "path": "x-pack/plugins/fleet/common/constants/index.ts", "lineNumber": 30 }, - "signature": [ - "\".fleet-servers\"" - ], + "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": 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": 356 - }, "signature": [ { "pluginId": "fleet", @@ -12931,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": 87 - }, "signature": [ { "pluginId": "fleet", @@ -12960,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": [], + "signature": [ + "T & { status: InstallationStatus['Installed']; savedObject: SavedObject; }" + ], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", "lineNumber": 358 }, - "signature": [ - "T & { status: InstallationStatus['Installed']; savedObject: SavedObject; }" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "fleet", "id": "def-common.InstallSource", "type": "Type", - "label": "InstallSource", "tags": [], + "label": "InstallSource", "description": [], + "signature": [ + "\"registry\" | \"upload\"" + ], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", "lineNumber": 39 }, - "signature": [ - "\"registry\" | \"upload\"" - ], + "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": 38 }, - "signature": [ - "\"update\" | \"unknown\" | \"reinstall\" | \"reupdate\" | \"rollback\" | \"install\"" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "fleet", "id": "def-common.KibanaAssetParts", "type": "Type", - "label": "KibanaAssetParts", "tags": [], + "label": "KibanaAssetParts", "description": [], + "signature": [ + "AssetParts & { service: Extract; type: KibanaAssetType; }" + ], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", "lineNumber": 235 }, - "signature": [ - "AssetParts & { service: Extract; type: KibanaAssetType; }" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "fleet", "id": "def-common.KibanaAssetReference", "type": "Type", - "label": "KibanaAssetReference", "tags": [], + "label": "KibanaAssetReference", "description": [], + "signature": [ + "Pick & { type: KibanaSavedObjectType; }" + ], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", "lineNumber": 369 }, - "signature": [ - "Pick & { type: KibanaSavedObjectType; }" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "fleet", "id": "def-common.KibanaAssetTypeToParts", "type": "Type", - "label": "KibanaAssetTypeToParts", "tags": [], + "label": "KibanaAssetTypeToParts", "description": [], + "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 }, - "signature": [ - "{ dashboard: KibanaAssetParts[]; visualization: KibanaAssetParts[]; search: KibanaAssetParts[]; index_pattern: KibanaAssetParts[]; map: KibanaAssetParts[]; lens: KibanaAssetParts[]; security_rule: KibanaAssetParts[]; ml_module: KibanaAssetParts[]; }" - ], + "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": [], + "signature": [ + "T & { status: InstallationStatus['NotInstalled']; }" + ], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", "lineNumber": 363 }, - "signature": [ - "T & { status: InstallationStatus['NotInstalled']; }" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "fleet", "id": "def-common.Output", "type": "Type", - "label": "Output", "tags": [], + "label": "Output", "description": [], + "signature": [ + "NewOutput & { id: string; }" + ], "source": { "path": "x-pack/plugins/fleet/common/types/models/output.ts", "lineNumber": 26 }, - "signature": [ - "NewOutput & { id: string; }" - ], + "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": [], + "signature": [ + "NewOutput" + ], "source": { "path": "x-pack/plugins/fleet/common/types/models/output.ts", "lineNumber": 24 }, - "signature": [ - "NewOutput" - ], + "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": [], + "signature": [ + "Pick & { type: typeof ASSETS_SAVED_OBJECT_TYPE; }" + ], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", "lineNumber": 376 }, - "signature": [ - "Pick & { type: typeof ASSETS_SAVED_OBJECT_TYPE; }" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "fleet", "id": "def-common.PackageInfo", "type": "Type", - "label": "PackageInfo", "tags": [], + "label": "PackageInfo", "description": [], - "source": { - "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "lineNumber": 335 - }, "signature": [ { "pluginId": "fleet", @@ -13265,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": [], + "signature": [ + "Installable>[]" + ], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", "lineNumber": 331 }, - "signature": [ - "Installable>[]" - ], + "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": 333 - }, "signature": [ { "pluginId": "fleet", @@ -13326,243 +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": [], + "signature": [ + "{ [x: string]: PackagePolicyConfigRecordEntry; }" + ], "source": { "path": "x-pack/plugins/fleet/common/types/models/package_policy.ts", "lineNumber": 20 }, - "signature": [ - "{ [x: string]: PackagePolicyConfigRecordEntry; }" - ], + "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": 76 }, - "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; }" - ], + "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": [], + "signature": [ + "{ installed: PackageList; not_installed: PackageList; }" + ], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", "lineNumber": 334 }, - "signature": [ - "{ installed: PackageList; not_installed: PackageList; }" - ], + "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\" | \"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\"" - ], + "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": [], + "signature": [ + "{ [x: string]: { success: boolean; error?: string | undefined; }; }" + ], "source": { "path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts", "lineNumber": 126 }, - "signature": [ - "{ [x: string]: { success: boolean; error?: string | undefined; }; }" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "fleet", "id": "def-common.PostBulkAgentUnenrollResponse", "type": "Type", - "label": "PostBulkAgentUnenrollResponse", "tags": [], + "label": "PostBulkAgentUnenrollResponse", "description": [], + "signature": [ + "{ [x: string]: { success: boolean; error?: string | undefined; }; }" + ], "source": { "path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts", "lineNumber": 72 }, - "signature": [ - "{ [x: string]: { success: boolean; error?: string | undefined; }; }" - ], + "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": 98 }, - "signature": [ - "{ [x: string]: { success: boolean; error?: string | undefined; }; }" - ], + "deprecated": false, "initialIsOpen": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.PRECONFIGURATION_DELETION_RECORD_SAVED_OBJECT_TYPE", "type": "string", + "tags": [], "label": "PRECONFIGURATION_DELETION_RECORD_SAVED_OBJECT_TYPE", "description": [], + "signature": [ + "\"fleet-preconfiguration-deletion-record\"" + ], "source": { "path": "x-pack/plugins/fleet/common/constants/preconfiguration.ts", "lineNumber": 12 }, - "signature": [ - "\"fleet-preconfiguration-deletion-record\"" - ], + "deprecated": false, "initialIsOpen": false }, { - "tags": [], + "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/constants/preconfiguration.ts", "lineNumber": 15 }, - "signature": [ - "\"latest\"" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "fleet", "id": "def-common.PreconfiguredPackage", "type": "Type", - "label": "PreconfiguredPackage", "tags": [], + "label": "PreconfiguredPackage", "description": [], + "signature": [ + "{ name: string; version: string; }" + ], "source": { "path": "x-pack/plugins/fleet/common/types/models/preconfiguration.ts", "lineNumber": 31 }, - "signature": [ - "{ name: string; version: string; }" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "fleet", "id": "def-common.RegistryPackage", "type": "Type", - "label": "RegistryPackage", "tags": [], + "label": "RegistryPackage", "description": [], + "signature": [ + "PackageSpecManifest & Partial> & RegistryAdditionalProperties & RegistryOverridePropertyValue" + ], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", "lineNumber": 93 }, - "signature": [ - "PackageSpecManifest & Partial> & RegistryAdditionalProperties & RegistryOverridePropertyValue" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "fleet", "id": "def-common.RegistryRelease", "type": "Type", - "label": "RegistryRelease", "tags": [], + "label": "RegistryRelease", "description": [], + "signature": [ + "\"experimental\" | \"beta\" | \"ga\"" + ], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", "lineNumber": 120 }, - "signature": [ - "\"experimental\" | \"beta\" | \"ga\"" - ], + "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": 192 - }, "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?: (", { @@ -13574,123 +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": [], + "signature": [ + "Pick[]" + ], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", "lineNumber": 190 }, - "signature": [ - "Pick[]" - ], + "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": 286 }, - "signature": [ - "\"string\" | \"text\" | \"password\" | \"integer\" | \"bool\" | \"yaml\"" - ], + "deprecated": false, "initialIsOpen": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.REQUIRED_PACKAGES", "type": "Array", + "tags": [], "label": "REQUIRED_PACKAGES", "description": [], + "signature": [ + "{ name: \"endpoint\" | \"fleet_server\" | \"system\" | \"elastic_agent\"; version: string; }[]" + ], "source": { "path": "x-pack/plugins/fleet/common/constants/preconfiguration.ts", "lineNumber": 65 }, - "signature": [ - "{ name: \"endpoint\" | \"fleet_server\" | \"system\" | \"elastic_agent\"; version: string; }[]" - ], + "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": 380 }, - "signature": [ - "{ readonly System: \"system\"; readonly Endpoint: \"endpoint\"; readonly ElasticAgent: \"elastic_agent\"; readonly FleetServer: \"fleet_server\"; }" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "fleet", "id": "def-common.RequirementsByServiceName", "type": "Type", - "label": "RequirementsByServiceName", "tags": [], + "label": "RequirementsByServiceName", "description": [], + "signature": [ + "undefined | Record<\"kibana\", { version: string; }>" + ], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", "lineNumber": 220 }, - "signature": [ - "undefined | Record<\"kibana\", { version: string; }>" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "fleet", "id": "def-common.RequirementVersion", "type": "Type", - "label": "RequirementVersion", "tags": [], + "label": "RequirementVersion", "description": [], + "signature": [ + "string" + ], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", "lineNumber": 181 }, - "signature": [ - "string" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "fleet", "id": "def-common.RequirementVersionRange", "type": "Type", - "label": "RequirementVersionRange", "tags": [], + "label": "RequirementVersionRange", "description": [], + "signature": [ + "string" + ], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", "lineNumber": 182 }, - "signature": [ - "string" - ], + "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": 208 - }, "signature": [ { "pluginId": "fleet", @@ -13708,2524 +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": [], + "signature": [ + "\"kibana\" | \"elasticsearch\"" + ], "source": { "path": "x-pack/plugins/fleet/common/types/models/epm.ts", "lineNumber": 44 }, - "signature": [ - "\"kibana\" | \"elasticsearch\"" - ], + "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": 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": [], + "signature": [ + "10000" + ], "source": { "path": "x-pack/plugins/fleet/common/constants/index.ts", "lineNumber": 24 }, - "signature": [ - "10000" - ], + "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" ], + "signature": [ + "T[keyof T]" + ], "source": { "path": "x-pack/plugins/fleet/common/types/index.ts", "lineNumber": 49 }, - "signature": [ - "T[keyof T]" - ], + "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": 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": 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": 86 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.AGENT_API_ROUTES.DELETE_PATTERN", "type": "string", + "tags": [], "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": 83 - }, "initialIsOpen": false }, { + "parentPluginId": "fleet", "id": "def-common.AGENT_POLICY_API_ROUTES", "type": "Object", "tags": [], + "label": "AGENT_POLICY_API_ROUTES", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/constants/routes.ts", + "lineNumber": 52 + }, + "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": [], + "signature": [ + "{ readonly Input: \"input\"; }" + ], "source": { "path": "x-pack/plugins/fleet/common/constants/epm.ts", "lineNumber": 24 }, - "signature": [ - "{ readonly Input: \"input\"; }" - ], + "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": [], + "signature": [ + "{ readonly Active: \"active\"; readonly Inactive: \"inactive\"; }" + ], "source": { "path": "x-pack/plugins/fleet/common/constants/agent_policy.ts", "lineNumber": 10 }, - "signature": [ - "{ readonly Active: \"active\"; readonly Inactive: \"inactive\"; }" - ], + "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", + "tags": [], + "label": "getInfoPath", + "description": [], + "signature": [ + "(agentId: string) => string" + ], + "source": { + "path": "x-pack/plugins/fleet/common/services/routes.ts", + "lineNumber": 135 + }, + "deprecated": false, "children": [ { + "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": 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": "getInfoPath", "source": { "path": "x-pack/plugins/fleet/common/services/routes.ts", - "lineNumber": 135 + "lineNumber": 136 }, - "tags": [], - "returnComment": [] - }, - { - "id": "def-common.agentRouteService.getUpdatePath", - "type": "Function", + "deprecated": false, "children": [ { + "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": 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": "getUpdatePath", "source": { "path": "x-pack/plugins/fleet/common/services/routes.ts", - "lineNumber": 136 + "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": 137 - } + }, + "deprecated": false, + "isRequired": true } ], - "signature": [ - "(agentId: string) => string" - ], - "description": [], - "label": "getUnenrollPath", - "source": { - "path": "x-pack/plugins/fleet/common/services/routes.ts", - "lineNumber": 137 - }, - "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": 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": 140 - } + }, + "deprecated": false, + "isRequired": true } ], - "signature": [ - "(agentId: string) => string" - ], - "description": [], - "label": "getReassignPath", - "source": { - "path": "x-pack/plugins/fleet/common/services/routes.ts", - "lineNumber": 140 - }, - "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": 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": 143 - } + }, + "deprecated": false, + "isRequired": true } ], - "signature": [ - "(agentId: string) => string" - ], - "description": [], - "label": "getUpgradePath", - "source": { - "path": "x-pack/plugins/fleet/common/services/routes.ts", - "lineNumber": 143 - }, - "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": 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": 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": 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": 148 - } + }, + "deprecated": false, + "isRequired": true } ], - "signature": [ - "(agentId: string) => string" - ], - "description": [], - "label": "getCreateActionPath", - "source": { - "path": "x-pack/plugins/fleet/common/services/routes.ts", - "lineNumber": 148 - }, - "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": 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": 111 - } + }, + "deprecated": false } ], - "description": [], - "label": "AGENTS_SETUP_API_ROUTES", - "source": { - "path": "x-pack/plugins/fleet/common/constants/routes.ts", - "lineNumber": 109 - }, "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 }, { - "tags": [], + "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" ], - "description": [], - "label": "getCheckPermissionsPath", "source": { "path": "x-pack/plugins/fleet/common/services/routes.ts", "lineNumber": 165 }, - "tags": [], + "deprecated": false, + "children": [], "returnComment": [] }, { + "parentPluginId": "fleet", "id": "def-common.appRoutesService.getRegenerateServiceTokenPath", "type": "Function", - "children": [], + "tags": [], + "label": "getRegenerateServiceTokenPath", + "description": [], "signature": [ "() => string" ], - "description": [], - "label": "getRegenerateServiceTokenPath", "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": 164 - }, "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": [], + "signature": [ + "{ readonly Logs: \"logs\"; readonly Metrics: \"metrics\"; }" + ], "source": { "path": "x-pack/plugins/fleet/common/constants/epm.ts", "lineNumber": 28 }, - "signature": [ - "{ readonly Logs: \"logs\"; readonly Metrics: \"metrics\"; }" - ], + "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/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/preconfiguration.ts", "lineNumber": 26 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.DEFAULT_AGENT_POLICY.description", "type": "string", + "tags": [], "label": "description", "description": [], "source": { "path": "x-pack/plugins/fleet/common/constants/preconfiguration.ts", "lineNumber": 27 - } + }, + "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/preconfiguration.ts", "lineNumber": 28 }, - "signature": [ - "{ name: string; package: { name: \"system\"; }; }[]" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.DEFAULT_AGENT_POLICY.is_default", "type": "boolean", + "tags": [], "label": "is_default", "description": [], + "signature": [ + "true" + ], "source": { "path": "x-pack/plugins/fleet/common/constants/preconfiguration.ts", "lineNumber": 36 }, - "signature": [ - "true" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.DEFAULT_AGENT_POLICY.is_managed", "type": "boolean", + "tags": [], "label": "is_managed", "description": [], + "signature": [ + "false" + ], "source": { "path": "x-pack/plugins/fleet/common/constants/preconfiguration.ts", "lineNumber": 37 }, - "signature": [ - "false" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.DEFAULT_AGENT_POLICY.monitoring_enabled", "type": "Array", + "tags": [], "label": "monitoring_enabled", "description": [], + "signature": [ + "(\"metrics\" | \"logs\")[]" + ], "source": { "path": "x-pack/plugins/fleet/common/constants/preconfiguration.ts", "lineNumber": 38 }, - "signature": [ - "(\"metrics\" | \"logs\")[]" - ] + "deprecated": false } ], - "description": [], - "label": "DEFAULT_AGENT_POLICY", - "source": { - "path": "x-pack/plugins/fleet/common/constants/preconfiguration.ts", - "lineNumber": 24 - }, "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/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/preconfiguration.ts", "lineNumber": 43 - } + }, + "deprecated": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.DEFAULT_FLEET_SERVER_AGENT_POLICY.description", "type": "string", + "tags": [], "label": "description", "description": [], "source": { "path": "x-pack/plugins/fleet/common/constants/preconfiguration.ts", "lineNumber": 44 - } + }, + "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/preconfiguration.ts", "lineNumber": 45 }, - "signature": [ - "{ name: string; package: { name: \"fleet_server\"; }; }[]" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.DEFAULT_FLEET_SERVER_AGENT_POLICY.is_default", "type": "boolean", + "tags": [], "label": "is_default", "description": [], + "signature": [ + "false" + ], "source": { "path": "x-pack/plugins/fleet/common/constants/preconfiguration.ts", "lineNumber": 53 }, - "signature": [ - "false" - ] + "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": [], + "signature": [ + "true" + ], "source": { "path": "x-pack/plugins/fleet/common/constants/preconfiguration.ts", "lineNumber": 54 }, - "signature": [ - "true" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.DEFAULT_FLEET_SERVER_AGENT_POLICY.is_managed", "type": "boolean", + "tags": [], "label": "is_managed", "description": [], + "signature": [ + "false" + ], "source": { "path": "x-pack/plugins/fleet/common/constants/preconfiguration.ts", "lineNumber": 55 }, - "signature": [ - "false" - ] + "deprecated": false }, { - "tags": [], + "parentPluginId": "fleet", "id": "def-common.DEFAULT_FLEET_SERVER_AGENT_POLICY.monitoring_enabled", "type": "Array", + "tags": [], "label": "monitoring_enabled", "description": [], + "signature": [ + "(\"metrics\" | \"logs\")[]" + ], "source": { "path": "x-pack/plugins/fleet/common/constants/preconfiguration.ts", "lineNumber": 56 }, - "signature": [ - "(\"metrics\" | \"logs\")[]" - ] + "deprecated": false } ], - "description": [], - "label": "DEFAULT_FLEET_SERVER_AGENT_POLICY", - "source": { - "path": "x-pack/plugins/fleet/common/constants/preconfiguration.ts", - "lineNumber": 41 - }, "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": 22 }, - "signature": [ - "{ readonly System: \"system\"; readonly Endpoint: \"endpoint\"; readonly ElasticAgent: \"elastic_agent\"; readonly FleetServer: \"fleet_server\"; }" - ], + "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": 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": 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": 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": 105 - } + }, + "deprecated": false } ], - "description": [], - "label": "ENROLLMENT_API_KEY_ROUTES", - "source": { - "path": "x-pack/plugins/fleet/common/constants/routes.ts", - "lineNumber": 101 - }, "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": [], + "signature": [ + "{ readonly Installed: \"installed\"; readonly NotInstalled: \"not_installed\"; }" + ], "source": { "path": "x-pack/plugins/fleet/common/constants/epm.ts", "lineNumber": 33 }, - "signature": [ - "{ readonly Installed: \"installed\"; readonly NotInstalled: \"not_installed\"; }" - ], + "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": 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": 153 + "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": 154 - } + }, + "deprecated": false, + "isRequired": true } ], - "signature": [ - "(outputId: string) => string" - ], - "description": [], - "label": "getUpdatePath", - "source": { - "path": "x-pack/plugins/fleet/common/services/routes.ts", - "lineNumber": 154 - }, - "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": 156 }, - "tags": [], + "deprecated": false, + "children": [], "returnComment": [] } ], - "description": [], - "label": "outputRoutesService", - "source": { - "path": "x-pack/plugins/fleet/common/services/routes.ts", - "lineNumber": 152 - }, "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": 120 - } + }, + "deprecated": false } ], - "description": [], - "label": "PRECONFIGURATION_API_ROUTES", - "source": { - "path": "x-pack/plugins/fleet/common/constants/routes.ts", - "lineNumber": 119 - }, "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\"; readonly FleetServer: \"fleet_server\"; }" - ], + "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": 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": 161 }, - "tags": [], + "deprecated": false, + "children": [], "returnComment": [] } ], - "description": [], - "label": "settingsRoutesService", - "source": { - "path": "x-pack/plugins/fleet/common/services/routes.ts", - "lineNumber": 159 - }, "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 4b7ae39d21b65..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,65 +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": 65 }, - "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; }>; }" - ], + "deprecated": false, "initialIsOpen": false }, { + "parentPluginId": "infra", "id": "def-server.InfraRequestHandlerContext", "type": "Type", - "label": "InfraRequestHandlerContext", "tags": [], + "label": "InfraRequestHandlerContext", "description": [], + "signature": [ + "InfraMlRequestHandlerContext & InfraSpacesRequestHandlerContext" + ], "source": { "path": "x-pack/plugins/infra/server/types.ts", "lineNumber": 24 }, - "signature": [ - "InfraMlRequestHandlerContext & InfraSpacesRequestHandlerContext" - ], + "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": 76 - }, "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": 75 - }, "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 8215c584f5be9..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,209 +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": 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": [ - "\nRenders a Monaco code editor with EUI color theme.\n" - ], - "label": "CodeEditor", "source": { "path": "src/plugins/kibana_react/public/code_editor/index.tsx", - "lineNumber": 34 + "lineNumber": 48 }, - "tags": [ - "see" - ], - "returnComment": [], - "initialIsOpen": false - }, - { - "id": "def-public.CodeEditorField", - "type": "Function", + "deprecated": false, "children": [ { + "parentPluginId": "kibanaReact", "id": "def-public.CodeEditorField.$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": 48 - } + }, + "deprecated": false, + "isRequired": true } ], - "signature": [ - "(props: React.PropsWithChildren<", - "Props", - ">) => JSX.Element" - ], - "description": [ - "\nRenders a Monaco code editor in the same style as other EUI form fields." - ], - "label": "CodeEditorField", - "source": { - "path": "src/plugins/kibana_react/public/code_editor/index.tsx", - "lineNumber": 48 - }, - "tags": [], "returnComment": [], "initialIsOpen": false }, { + "parentPluginId": "kibanaReact", "id": "def-public.createKibanaReactContext", "type": "Function", - "children": [ - { - "id": "def-public.createKibanaReactContext.$1", - "type": "Uncategorized", - "label": "services", - "isRequired": true, - "signature": [ - "Services" - ], - "description": [], - "source": { - "path": "src/plugins/kibana_react/public/context/context.tsx", - "lineNumber": 46 - } - } - ], + "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<", { @@ -770,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<", { @@ -800,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<", { @@ -825,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}: ", { @@ -850,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", @@ -866,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}: ", { @@ -896,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", @@ -914,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 } ], + "returnComment": [], + "initialIsOpen": false + }, + { + "parentPluginId": "kibanaReact", + "id": "def-public.MarkdownSimple", + "type": "Function", + "tags": [], + "label": "MarkdownSimple", + "description": [], "signature": [ "(props: ", - "MarkdownProps", + "MarkdownSimpleProps", ") => JSX.Element" ], - "description": [], - "label": "Markdown", "source": { "path": "src/plugins/kibana_react/public/markdown/index.tsx", - "lineNumber": 28 + "lineNumber": 21 }, - "tags": [], - "returnComment": [], - "initialIsOpen": false - }, - { - "id": "def-public.MarkdownSimple", - "type": "Function", + "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", " | ", @@ -1199,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", @@ -1245,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", " | ", @@ -1278,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) => ", @@ -1366,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) => ", @@ -1442,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<", { @@ -1474,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", @@ -1521,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<", { @@ -1585,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": [ "() => ", { @@ -1636,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: ", { @@ -1666,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", @@ -1874,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